Search Toolkit Book for CMedline_entry
#include <objects/medline/Medline_entry.hpp>
Inheritance diagram for CMedline_entry:
Collaboration diagram for CMedline_entry:
Public Member Functions | |
| CMedline_entry (void) | |
| ~CMedline_entry (void) | |
| Public Member Functions inherited from CMedline_entry_Base | |
| CMedline_entry_Base (void) | |
| virtual | ~CMedline_entry_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetUid (void) const |
| MEDLINE UID, sometimes not yet available if from PubMed Check if a value has been assigned to Uid data member. More... | |
| bool | CanGetUid (void) const |
| Check if it is safe to call GetUid method. More... | |
| void | ResetUid (void) |
| Reset Uid data member. More... | |
| TUid | GetUid (void) const |
| Get the Uid member data. More... | |
| void | SetUid (TUid value) |
| Assign a value to Uid data member. More... | |
| TUid & | SetUid (void) |
| Assign a value to Uid data member. More... | |
| bool | IsSetEm (void) const |
| Entry Month Check if a value has been assigned to Em data member. More... | |
| bool | CanGetEm (void) const |
| Check if it is safe to call GetEm method. More... | |
| void | ResetEm (void) |
| Reset Em data member. More... | |
| const TEm & | GetEm (void) const |
| Get the Em member data. More... | |
| void | SetEm (TEm &value) |
| Assign a value to Em data member. More... | |
| TEm & | SetEm (void) |
| Assign a value to Em data member. More... | |
| bool | IsSetCit (void) const |
| article citation Check if a value has been assigned to Cit data member. More... | |
| bool | CanGetCit (void) const |
| Check if it is safe to call GetCit method. More... | |
| void | ResetCit (void) |
| Reset Cit data member. More... | |
| const TCit & | GetCit (void) const |
| Get the Cit member data. More... | |
| void | SetCit (TCit &value) |
| Assign a value to Cit data member. More... | |
| TCit & | SetCit (void) |
| Assign a value to Cit data member. More... | |
| bool | IsSetAbstract (void) const |
| Check if a value has been assigned to Abstract data member. More... | |
| bool | CanGetAbstract (void) const |
| Check if it is safe to call GetAbstract method. More... | |
| void | ResetAbstract (void) |
| Reset Abstract data member. More... | |
| const TAbstract & | GetAbstract (void) const |
| Get the Abstract member data. More... | |
| void | SetAbstract (const TAbstract &value) |
| Assign a value to Abstract data member. More... | |
| void | SetAbstract (TAbstract &&value) |
| TAbstract & | SetAbstract (void) |
| Assign a value to Abstract data member. More... | |
| bool | IsSetMesh (void) const |
| Check if a value has been assigned to Mesh data member. More... | |
| bool | CanGetMesh (void) const |
| Check if it is safe to call GetMesh method. More... | |
| void | ResetMesh (void) |
| Reset Mesh data member. More... | |
| const TMesh & | GetMesh (void) const |
| Get the Mesh member data. More... | |
| TMesh & | SetMesh (void) |
| Assign a value to Mesh data member. More... | |
| bool | IsSetSubstance (void) const |
| Check if a value has been assigned to Substance data member. More... | |
| bool | CanGetSubstance (void) const |
| Check if it is safe to call GetSubstance method. More... | |
| void | ResetSubstance (void) |
| Reset Substance data member. More... | |
| const TSubstance & | GetSubstance (void) const |
| Get the Substance member data. More... | |
| TSubstance & | SetSubstance (void) |
| Assign a value to Substance data member. More... | |
| bool | IsSetXref (void) const |
| Check if a value has been assigned to Xref data member. More... | |
| bool | CanGetXref (void) const |
| Check if it is safe to call GetXref method. More... | |
| void | ResetXref (void) |
| Reset Xref data member. More... | |
| const TXref & | GetXref (void) const |
| Get the Xref member data. More... | |
| TXref & | SetXref (void) |
| Assign a value to Xref data member. More... | |
| bool | IsSetIdnum (void) const |
| ID Number (grants, contracts) Check if a value has been assigned to Idnum data member. More... | |
| bool | CanGetIdnum (void) const |
| Check if it is safe to call GetIdnum method. More... | |
| void | ResetIdnum (void) |
| Reset Idnum data member. More... | |
| const TIdnum & | GetIdnum (void) const |
| Get the Idnum member data. More... | |
| TIdnum & | SetIdnum (void) |
| Assign a value to Idnum data member. More... | |
| bool | IsSetGene (void) const |
| Check if a value has been assigned to Gene data member. More... | |
| bool | CanGetGene (void) const |
| Check if it is safe to call GetGene method. More... | |
| void | ResetGene (void) |
| Reset Gene data member. More... | |
| const TGene & | GetGene (void) const |
| Get the Gene member data. More... | |
| TGene & | SetGene (void) |
| Assign a value to Gene data member. More... | |
| bool | IsSetPmid (void) const |
| MEDLINE records may include the PubMedId Check if a value has been assigned to Pmid data member. More... | |
| bool | CanGetPmid (void) const |
| Check if it is safe to call GetPmid method. More... | |
| void | ResetPmid (void) |
| Reset Pmid data member. More... | |
| const TPmid & | GetPmid (void) const |
| Get the Pmid member data. More... | |
| void | SetPmid (const TPmid &value) |
| Assign a value to Pmid data member. More... | |
| TPmid & | SetPmid (void) |
| Assign a value to Pmid data member. More... | |
| bool | IsSetPub_type (void) const |
| may show publication types (review, etc) Check if a value has been assigned to Pub_type data member. More... | |
| bool | CanGetPub_type (void) const |
| Check if it is safe to call GetPub_type method. More... | |
| void | ResetPub_type (void) |
| Reset Pub_type data member. More... | |
| const TPub_type & | GetPub_type (void) const |
| Get the Pub_type member data. More... | |
| TPub_type & | SetPub_type (void) |
| Assign a value to Pub_type data member. More... | |
| bool | IsSetMlfield (void) const |
| additional Medline field types Check if a value has been assigned to Mlfield data member. More... | |
| bool | CanGetMlfield (void) const |
| Check if it is safe to call GetMlfield method. More... | |
| void | ResetMlfield (void) |
| Reset Mlfield data member. More... | |
| const TMlfield & | GetMlfield (void) const |
| Get the Mlfield member data. More... | |
| TMlfield & | SetMlfield (void) |
| Assign a value to Mlfield data member. More... | |
| bool | IsSetStatus (void) const |
| Check if a value has been assigned to Status data member. More... | |
| bool | CanGetStatus (void) const |
| Check if it is safe to call GetStatus method. More... | |
| void | ResetStatus (void) |
| Reset Status data member. More... | |
| void | SetDefaultStatus (void) |
| Assign default value to Status data member. More... | |
| TStatus | GetStatus (void) const |
| Get the Status member data. More... | |
| void | SetStatus (TStatus value) |
| Assign a value to Status data member. More... | |
| TStatus & | SetStatus (void) |
| Assign a value to Status data member. More... | |
| virtual void | Reset (void) |
| Reset the whole object. More... | |
| Public Member Functions inherited from CSerialObject | |
| CSerialObject (void) | |
| virtual | ~CSerialObject (void) |
| virtual const CTypeInfo * | GetThisTypeInfo (void) const =0 |
| virtual void | Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive) |
| Set object to copy of another one. More... | |
| virtual bool | Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const |
| Check if both objects contain the same values. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| void | ThrowUnassigned (TMemberIndex index) const |
| void | ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const |
| bool | HasNamespaceName (void) const |
| Check if object data type has namespace name. More... | |
| const string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (void) const |
| Get namespace prefix. More... | |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
| Public Member Functions inherited from ICitationBase | |
| bool | GetLabel (string *label, TLabelFlags flags=0, ELabelVersion version=eLabel_DefaultVersion) const override |
| Append a label to the specified string per the specified flags. More... | |
| bool | GetLabel (string *label, bool unique) const |
| Public Member Functions inherited from IAbstractCitation | |
| virtual | ~IAbstractCitation () |
Protected Member Functions | |
| bool | GetLabelV1 (string *label, TLabelFlags flags) const override |
| bool | GetLabelV2 (string *label, TLabelFlags flags) const override |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Private Types | |
| typedef CMedline_entry_Base | Tparent |
Private Member Functions | |
| CMedline_entry (const CMedline_entry &value) | |
| CMedline_entry & | operator= (const CMedline_entry &value) |
Additional Inherited Members | |
| Public Types inherited from CMedline_entry_Base | |
| enum | EStatus { eStatus_publisher = 1 , eStatus_premedline = 2 , eStatus_medline = 3 } |
| enum class | E_memberIndex { e__allMandatory = 0 , e_uid , e_em , e_cit , e_abstract , e_mesh , e_substance , e_xref , e_idnum , e_gene , e_pmid , e_pub_type , e_mlfield , e_status } |
| typedef NCBI_NS_NCBI::TEntrezId | TUid |
| typedef CDate | TEm |
| typedef CCit_art | TCit |
| typedef string | TAbstract |
| typedef list< CRef< CMedline_mesh > > | TMesh |
| typedef list< CRef< CMedline_rn > > | TSubstance |
| typedef list< CRef< CMedline_si > > | TXref |
| typedef list< string > | TIdnum |
| typedef list< string > | TGene |
| typedef CPubMedId | TPmid |
| typedef list< string > | TPub_type |
| typedef list< CRef< CMedline_field > > | TMlfield |
| typedef int | TStatus |
| typedef Tparent::CMemberIndex< E_memberIndex, 14 > | TmemberIndex |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
| Public Types inherited from IAbstractCitation | |
| enum | ELabelFlags { fLabel_Unique = 1 << 0 , fLabel_FlatNCBI = 1 << 1 , fLabel_FlatEMBL = 1 << 2 , fLabel_ISO_JTA = 1 << 3 , fLabel_NoBadCitGen = 1 << 4 , fLabel_NoUnpubAffil = 1 << 5 , fLabel_Consortia = 1 << 30 } |
| Flags for use by GetLabel methods. More... | |
| enum | ELabelVersion { eLabel_V1 = 1 , eLabel_V2 = 2 , eLabel_MinVersion = eLabel_V1 , eLabel_DefaultVersion = eLabel_V1 , eLabel_MaxVersion = eLabel_V2 } |
| typedef int | TLabelFlags |
| binary OR of ELabelFlags More... | |
| Static Public Member Functions inherited from CMedline_entry_Base | |
| static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() | EStatus (void) |
| Access to EStatus's attributes (values, names) as defined in spec. More... | |
| Static Public Member Functions inherited from CSerialObject | |
| static void | SetVerifyDataThread (ESerialVerifyData verify) |
| static void | SetVerifyDataGlobal (ESerialVerifyData verify) |
| static string | UnassignedString (void) |
| static CStringUTF8 | UnassignedStringUTF8 (void) |
| static char | UnassignedByte (void) |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
| Static Public Member Functions inherited from ICitationBase | |
| static string | FixPages (const string &orig_pages) |
| Canonicalize a range of page numbers, expanding Medline-style 125-35 -> 125-135, F124-34 -> F124-F134, and 12a-c -> 12a-12c, and returning a single number (without a dash) for a single page. More... | |
| static string | GetParenthesizedYear (const CDate &date) |
| static bool | HasText (const string &s) |
| static bool | HasText (const string *s) |
| static void | MaybeAddSpace (string *label) |
| static void | NoteSup (string *label, const CImprint &imp) |
| static bool | SWNC (const string &str, const string &pfx) |
| Static Public Attributes inherited from CSerialObject | |
| static const char * | ms_UnassignedStr = "<*unassigned*>" |
| static const char | ms_UnassignedByte = char(0xcd) |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
| Static Protected Member Functions inherited from ICitationBase | |
| static bool | x_GetLabelV1 (string *label, bool unique, const CAuth_list *authors, const CImprint *imprint, const CTitle *title, const CCit_book *book, const CCit_jour *journal, const string *title1=0, const string *title2=0, const string *titleunique=0, const string *date=0, const string *volume=0, const string *issue=0, const string *pages=0, bool unpublished=false) |
Detailed Description
Definition at line 52 of file Medline_entry.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 55 of file Medline_entry.hpp.
Constructor & Destructor Documentation
◆ CMedline_entry() [1/2]
|
inline |
Definition at line 80 of file Medline_entry.hpp.
◆ ~CMedline_entry()
| CMedline_entry::~CMedline_entry | ( | void | ) |
Definition at line 51 of file Medline_entry.cpp.
◆ CMedline_entry() [2/2]
|
private |
Member Function Documentation
◆ GetLabelV1()
|
overrideprotectedvirtual |
Implements ICitationBase.
Definition at line 56 of file Medline_entry.cpp.
References IAbstractCitation::eLabel_V1, flags, Get(), CMedline_entry_Base::GetCit(), ICitationBase::GetLabel(), CMedline_entry_Base::GetPmid(), CMedline_entry_Base::GetUid(), CMedline_entry_Base::IsSetPmid(), CMedline_entry_Base::IsSetUid(), label, and NStr::NumericToString().
◆ GetLabelV2()
|
overrideprotectedvirtual |
Implements ICitationBase.
Definition at line 75 of file Medline_entry.cpp.
References IAbstractCitation::eLabel_V2, flags, CMedline_entry_Base::GetCit(), ICitationBase::GetLabel(), and label.
◆ operator=()
|
private |
The documentation for this class was generated from the following files:
- include/objects/medline/Medline_entry.hpp
- src/objects/medline/Medline_entry.cpp
