Search Toolkit Book for CArticleId
#include <objects/biblio/ArticleId.hpp>
Inheritance diagram for CArticleId:
Collaboration diagram for CArticleId:
Public Member Functions | |
| CArticleId (void) | |
| ~CArticleId (void) | |
| CArticleId (void) | |
| CArticleId (const std::string &value) | |
| ~CArticleId (void) | |
| operator const TArticleId & (void) const | |
| Conversion operator to 'TArticleId' type. More... | |
| CArticleId & | operator= (const TArticleId &value) |
| Assignment operator. More... | |
| Public Member Functions inherited from CArticleId_Base | |
| CArticleId_Base (void) | |
| virtual | ~CArticleId_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| virtual void | Reset (void) |
| Reset the whole object. More... | |
| virtual void | ResetSelection (void) |
| Reset the selection (set it to e_not_set). More... | |
| E_Choice | Which (void) const |
| Which variant is currently selected. More... | |
| void | CheckSelected (E_Choice index) const |
| Verify selection, throw exception if it differs from the expected. More... | |
| void | ThrowInvalidSelection (E_Choice index) const |
| Throw 'InvalidSelection' exception. More... | |
| void | Select (E_Choice index, EResetVariant reset=eDoResetVariant) |
| Select the requested variant if needed. More... | |
| void | Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool) |
| Select the requested variant if needed, allocating CObject variants from memory pool. More... | |
| bool | IsPubmed (void) const |
| Check if variant Pubmed is selected. More... | |
| const TPubmed & | GetPubmed (void) const |
| Get the variant data. More... | |
| TPubmed & | SetPubmed (void) |
| Select the variant. More... | |
| void | SetPubmed (const TPubmed &value) |
| Select the variant and set its data. More... | |
| bool | IsMedline (void) const |
| Check if variant Medline is selected. More... | |
| const TMedline & | GetMedline (void) const |
| Get the variant data. More... | |
| TMedline & | SetMedline (void) |
| Select the variant. More... | |
| void | SetMedline (const TMedline &value) |
| Select the variant and set its data. More... | |
| bool | IsDoi (void) const |
| Check if variant Doi is selected. More... | |
| const TDoi & | GetDoi (void) const |
| Get the variant data. More... | |
| TDoi & | SetDoi (void) |
| Select the variant. More... | |
| void | SetDoi (const TDoi &value) |
| Select the variant and set its data. More... | |
| bool | IsPii (void) const |
| Check if variant Pii is selected. More... | |
| const TPii & | GetPii (void) const |
| Get the variant data. More... | |
| TPii & | SetPii (void) |
| Select the variant. More... | |
| void | SetPii (const TPii &value) |
| Select the variant and set its data. More... | |
| bool | IsPmcid (void) const |
| Check if variant Pmcid is selected. More... | |
| const TPmcid & | GetPmcid (void) const |
| Get the variant data. More... | |
| TPmcid & | SetPmcid (void) |
| Select the variant. More... | |
| void | SetPmcid (const TPmcid &value) |
| Select the variant and set its data. More... | |
| bool | IsPmcpid (void) const |
| Check if variant Pmcpid is selected. More... | |
| const TPmcpid & | GetPmcpid (void) const |
| Get the variant data. More... | |
| TPmcpid & | SetPmcpid (void) |
| Select the variant. More... | |
| void | SetPmcpid (const TPmcpid &value) |
| Select the variant and set its data. More... | |
| bool | IsPmpid (void) const |
| Check if variant Pmpid is selected. More... | |
| const TPmpid & | GetPmpid (void) const |
| Get the variant data. More... | |
| TPmpid & | SetPmpid (void) |
| Select the variant. More... | |
| void | SetPmpid (const TPmpid &value) |
| Select the variant and set its data. More... | |
| bool | IsOther (void) const |
| Check if variant Other is selected. More... | |
| const TOther & | GetOther (void) const |
| Get the variant data. More... | |
| TOther & | SetOther (void) |
| Select the variant. More... | |
| void | SetOther (TOther &value) |
| Select the variant and set its data. More... | |
| CArticleId_Base (void) | |
| virtual | ~CArticleId_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetAttlist (void) const |
| Check if a value has been assigned to Attlist data member. More... | |
| bool | CanGetAttlist (void) const |
| Check if it is safe to call GetAttlist method. More... | |
| void | ResetAttlist (void) |
| Reset Attlist data member. More... | |
| const TAttlist & | GetAttlist (void) const |
| Get the Attlist member data. More... | |
| void | SetAttlist (TAttlist &value) |
| Assign a value to Attlist data member. More... | |
| TAttlist & | SetAttlist (void) |
| Assign a value to Attlist data member. More... | |
| bool | IsSetArticleId (void) const |
| Check if a value has been assigned to ArticleId data member. More... | |
| bool | CanGetArticleId (void) const |
| Check if it is safe to call GetArticleId method. More... | |
| void | ResetArticleId (void) |
| Reset ArticleId data member. More... | |
| const TArticleId & | GetArticleId (void) const |
| Get the ArticleId member data. More... | |
| void | SetArticleId (const TArticleId &value) |
| Assign a value to ArticleId data member. More... | |
| void | SetArticleId (TArticleId &&value) |
| TArticleId & | SetArticleId (void) |
| Assign a value to ArticleId 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 |
Private Types | |
| typedef CArticleId_Base | Tparent |
| typedef CArticleId_Base | Tparent |
Private Member Functions | |
| CArticleId (const CArticleId &value) | |
| CArticleId & | operator= (const CArticleId &value) |
| CArticleId (const CArticleId &value) | |
| CArticleId & | operator= (const CArticleId &value) |
Additional Inherited Members | |
| Public Types inherited from CArticleId_Base | |
| enum | E_Choice { e_not_set = 0 , e_Pubmed , e_Medline , e_Doi , e_Pii , e_Pmcid , e_Pmcpid , e_Pmpid , e_Other } |
| Choice variants. More... | |
| enum | E_ChoiceStopper { e_MaxChoice = 9 } |
| Maximum+1 value of the choice variant enumerator. More... | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_Attlist , e_ArticleId } |
| typedef CPubMedId | TPubmed |
| typedef CMedlineUID | TMedline |
| typedef CDOI | TDoi |
| typedef CPII | TPii |
| typedef CPmcID | TPmcid |
| typedef CPmcPid | TPmcpid |
| typedef CPmPid | TPmpid |
| typedef CDbtag | TOther |
| typedef C_Attlist | TAttlist |
| typedef NCBI_NS_STD::string | TArticleId |
| typedef Tparent::CMemberIndex< E_memberIndex, 3 > | 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... | |
| Static Public Member Functions inherited from CArticleId_Base | |
| static string | SelectionName (E_Choice index) |
| Retrieve selection name (for diagnostic purposes). 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 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... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
CArticleId –.
Definition at line 65 of file ArticleId.hpp.
The documentation for this class was generated from the following files:
- include/objects/biblio/ArticleId.hpp
- src/objects/biblio/ArticleId.cpp
