Search Toolkit Book for CGlobal_id_Base
Cdd's should not exist without a unique accession, but alternative id's may be present as well. More...
#include <objects/cdd/Global_id_.hpp>
Inheritance diagram for CGlobal_id_Base:
Collaboration diagram for CGlobal_id_Base:
Public Types | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_accession , e_release , e_version , e_database } |
| typedef string | TAccession |
| typedef string | TRelease |
| typedef int | TVersion |
| typedef string | TDatabase |
| typedef Tparent::CMemberIndex< E_memberIndex, 5 > | 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 Member Functions | |
| CGlobal_id_Base (void) | |
| virtual | ~CGlobal_id_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetAccession (void) const |
| SMART, Pfam, LOAD or CD accession Check if a value has been assigned to Accession data member. More... | |
| bool | CanGetAccession (void) const |
| Check if it is safe to call GetAccession method. More... | |
| void | ResetAccession (void) |
| Reset Accession data member. More... | |
| const TAccession & | GetAccession (void) const |
| Get the Accession member data. More... | |
| void | SetAccession (const TAccession &value) |
| Assign a value to Accession data member. More... | |
| void | SetAccession (TAccession &&value) |
| TAccession & | SetAccession (void) |
| Assign a value to Accession data member. More... | |
| bool | IsSetRelease (void) const |
| to hold CD-Database release number if desired, currently not used Check if a value has been assigned to Release data member. More... | |
| bool | CanGetRelease (void) const |
| Check if it is safe to call GetRelease method. More... | |
| void | ResetRelease (void) |
| Reset Release data member. More... | |
| const TRelease & | GetRelease (void) const |
| Get the Release member data. More... | |
| void | SetRelease (const TRelease &value) |
| Assign a value to Release data member. More... | |
| void | SetRelease (TRelease &&value) |
| TRelease & | SetRelease (void) |
| Assign a value to Release data member. More... | |
| bool | IsSetVersion (void) const |
| version 0 is the seed, version numbers increase with update/curate cycles Check if a value has been assigned to Version data member. More... | |
| bool | CanGetVersion (void) const |
| Check if it is safe to call GetVersion method. More... | |
| void | ResetVersion (void) |
| Reset Version data member. More... | |
| TVersion | GetVersion (void) const |
| Get the Version member data. More... | |
| void | SetVersion (TVersion value) |
| Assign a value to Version data member. More... | |
| TVersion & | SetVersion (void) |
| Assign a value to Version data member. More... | |
| bool | IsSetDatabase (void) const |
| this is NOT the source!, rather the Check if a value has been assigned to Database data member. More... | |
| bool | CanGetDatabase (void) const |
| Check if it is safe to call GetDatabase method. More... | |
| void | ResetDatabase (void) |
| Reset Database data member. More... | |
| const TDatabase & | GetDatabase (void) const |
| Get the Database member data. More... | |
| void | SetDatabase (const TDatabase &value) |
| Assign a value to Database data member. More... | |
| void | SetDatabase (TDatabase &&value) |
| TDatabase & | SetDatabase (void) |
| Assign a value to Database 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 CSerialObject | Tparent |
Private Member Functions | |
| CGlobal_id_Base (const CGlobal_id_Base &) | |
| CGlobal_id_Base & | operator= (const CGlobal_id_Base &) |
Private Attributes | |
| Uint4 | m_set_State [1] |
| string | m_Accession |
| string | m_Release |
| int | m_Version |
| string | m_Database |
Additional Inherited Members | |
| 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
Cdd's should not exist without a unique accession, but alternative id's may be present as well.
It is conceivable that a CD which is created as a merged product of two highly redundant CDs will retain the source ids in addition to its new unique id database the object resides in currently not in use
Definition at line 78 of file Global_id_.hpp.
The documentation for this class was generated from the following files:
- include/objects/cdd/Global_id_.hpp
- src/objects/cdd/Global_id_.cpp
