NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members

Represents ASN.1 type Global-id defined in file cdd.asn

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

typedef string TAccession
 
typedef string TRelease
 
typedef int TVersion
 
typedef string TDatabase
 
- 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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue 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 TAccessionGetAccession (void) const
 Get the Accession member data. More...
 
void SetAccession (const TAccession &value)
 Assign a value to Accession data member. More...
 
TAccessionSetAccession (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 TReleaseGetRelease (void) const
 Get the Release member data. More...
 
void SetRelease (const TRelease &value)
 Assign a value to Release data member. More...
 
TReleaseSetRelease (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...
 
TVersionSetVersion (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 TDatabaseGetDatabase (void) const
 Get the Database member data. More...
 
void SetDatabase (const TDatabase &value)
 Assign a value to Database data member. More...
 
TDatabaseSetDatabase (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 CTypeInfoGetThisTypeInfo (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 stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (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...
 
CObjectoperator= (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_Baseoperator= (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_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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

CGlobal_id_Base

Definition at line 78 of file Global_id_.hpp.

Member Typedef Documentation

Definition at line 91 of file Global_id_.hpp.

Definition at line 94 of file Global_id_.hpp.

Definition at line 80 of file Global_id_.hpp.

Definition at line 92 of file Global_id_.hpp.

Definition at line 93 of file Global_id_.hpp.

Constructor & Destructor Documentation

END_CLASS_INFO CGlobal_id_Base::CGlobal_id_Base ( void  )

Definition at line 89 of file Global_id_.cpp.

References m_set_State.

CGlobal_id_Base::~CGlobal_id_Base ( void  )
virtual

Definition at line 96 of file Global_id_.cpp.

CGlobal_id_Base::CGlobal_id_Base ( const CGlobal_id_Base )
private

Member Function Documentation

bool CGlobal_id_Base::CanGetAccession ( void  ) const
inline

Check if it is safe to call GetAccession method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 287 of file Global_id_.hpp.

References IsSetAccession().

Referenced by GetAccession().

bool CGlobal_id_Base::CanGetDatabase ( void  ) const
inline

Check if it is safe to call GetDatabase method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 414 of file Global_id_.hpp.

References IsSetDatabase().

Referenced by GetDatabase().

bool CGlobal_id_Base::CanGetRelease ( void  ) const
inline

Check if it is safe to call GetRelease method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 327 of file Global_id_.hpp.

References IsSetRelease().

Referenced by GetRelease().

bool CGlobal_id_Base::CanGetVersion ( void  ) const
inline

Check if it is safe to call GetVersion method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 367 of file Global_id_.hpp.

References IsSetVersion().

Referenced by GetVersion().

CGlobal_id_Base::DECLARE_INTERNAL_TYPE_INFO ( )
const CGlobal_id_Base::TAccession & CGlobal_id_Base::GetAccession ( void  ) const
inline

Get the Accession member data.

Returns
Reference to the member data.

Definition at line 293 of file Global_id_.hpp.

References CanGetAccession(), m_Accession, and CSerialObject::ThrowUnassigned().

Referenced by CCdCore::GetClassicalParentAccession(), and SameCDAccession().

const CGlobal_id_Base::TDatabase & CGlobal_id_Base::GetDatabase ( void  ) const
inline

Get the Database member data.

Returns
Reference to the member data.

Definition at line 420 of file Global_id_.hpp.

References CanGetDatabase(), m_Database, and CSerialObject::ThrowUnassigned().

const CGlobal_id_Base::TRelease & CGlobal_id_Base::GetRelease ( void  ) const
inline

Get the Release member data.

Returns
Reference to the member data.

Definition at line 333 of file Global_id_.hpp.

References CanGetRelease(), m_Release, and CSerialObject::ThrowUnassigned().

CGlobal_id_Base::TVersion CGlobal_id_Base::GetVersion ( void  ) const
inline

Get the Version member data.

Returns
Copy of the member data.

Definition at line 380 of file Global_id_.hpp.

References CanGetVersion(), m_Version, and CSerialObject::ThrowUnassigned().

Referenced by CCdCore::GetClassicalParentAccession().

bool CGlobal_id_Base::IsSetAccession ( void  ) const
inline

SMART, Pfam, LOAD or CD accession Check if a value has been assigned to Accession data member.

Data member Accession is mandatory; its type is defined as 'typedef string TAccession'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 281 of file Global_id_.hpp.

References m_set_State.

Referenced by CanGetAccession(), and SetAccession().

bool CGlobal_id_Base::IsSetDatabase ( void  ) const
inline

this is NOT the source!, rather the Check if a value has been assigned to Database data member.

Data member Database is optional; its type is defined as 'typedef string TDatabase'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 408 of file Global_id_.hpp.

References m_set_State.

Referenced by CanGetDatabase(), and SetDatabase().

bool CGlobal_id_Base::IsSetRelease ( void  ) const
inline

to hold CD-Database release number if desired, currently not used Check if a value has been assigned to Release data member.

Data member Release is optional; its type is defined as 'typedef string TRelease'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 321 of file Global_id_.hpp.

References m_set_State.

Referenced by CanGetRelease(), and SetRelease().

bool CGlobal_id_Base::IsSetVersion ( void  ) const
inline

version 0 is the seed, version numbers increase with update/curate cycles Check if a value has been assigned to Version data member.

Data member Version is optional; its type is defined as 'typedef int TVersion'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 361 of file Global_id_.hpp.

References m_set_State.

Referenced by CanGetVersion(), CCdCore::GetClassicalParentAccession(), and SetVersion().

CGlobal_id_Base& CGlobal_id_Base::operator= ( const CGlobal_id_Base )
private
void CGlobal_id_Base::Reset ( void  )
virtual

Reset the whole object.

Definition at line 68 of file Global_id_.cpp.

References ResetAccession(), ResetDatabase(), ResetRelease(), and ResetVersion().

Referenced by CCdCore::SetOldRoot(), and CCdFromFasta::UpdateSourceId().

void CGlobal_id_Base::ResetAccession ( void  )

Reset Accession data member.

Definition at line 50 of file Global_id_.cpp.

References m_Accession, and m_set_State.

Referenced by Reset().

void CGlobal_id_Base::ResetDatabase ( void  )

Reset Database data member.

Definition at line 62 of file Global_id_.cpp.

References m_Database, and m_set_State.

Referenced by Reset().

void CGlobal_id_Base::ResetRelease ( void  )

Reset Release data member.

Definition at line 56 of file Global_id_.cpp.

References m_Release, and m_set_State.

Referenced by Reset().

void CGlobal_id_Base::ResetVersion ( void  )
inline

Reset Version data member.

Definition at line 373 of file Global_id_.hpp.

References m_set_State, and m_Version.

Referenced by Reset().

void CGlobal_id_Base::SetAccession ( const TAccession value)
inline

Assign a value to Accession data member.

Parameters
valueValue to assign

Definition at line 302 of file Global_id_.hpp.

References m_Accession, m_set_State, and value.

Referenced by CSeqAnnotFromFasta::MakeSeqAnnotFromFasta(), CCdCore::SetAccession(), CCdCore::SetClassicalParentAccessionNew(), CCdCore::SetOldRoot(), and CCdFromFasta::UpdateSourceId().

CGlobal_id_Base::TAccession & CGlobal_id_Base::SetAccession ( void  )
inline

Assign a value to Accession data member.

Returns
Reference to the data value.

Definition at line 309 of file Global_id_.hpp.

References IsSetAccession(), m_Accession, m_set_State, and CSerialObject::UnassignedString().

void CGlobal_id_Base::SetDatabase ( const TDatabase value)
inline

Assign a value to Database data member.

Parameters
valueValue to assign

Definition at line 429 of file Global_id_.hpp.

References m_Database, m_set_State, and value.

CGlobal_id_Base::TDatabase & CGlobal_id_Base::SetDatabase ( void  )
inline

Assign a value to Database data member.

Returns
Reference to the data value.

Definition at line 436 of file Global_id_.hpp.

References IsSetDatabase(), m_Database, m_set_State, and CSerialObject::UnassignedString().

void CGlobal_id_Base::SetRelease ( const TRelease value)
inline

Assign a value to Release data member.

Parameters
valueValue to assign

Definition at line 342 of file Global_id_.hpp.

References m_Release, m_set_State, and value.

CGlobal_id_Base::TRelease & CGlobal_id_Base::SetRelease ( void  )
inline

Assign a value to Release data member.

Returns
Reference to the data value.

Definition at line 349 of file Global_id_.hpp.

References IsSetRelease(), m_Release, m_set_State, and CSerialObject::UnassignedString().

void CGlobal_id_Base::SetVersion ( CGlobal_id_Base::TVersion  value)
inline

Assign a value to Version data member.

Parameters
valueValue to assign

Definition at line 389 of file Global_id_.hpp.

References m_set_State, m_Version, and value.

Referenced by CSeqAnnotFromFasta::MakeSeqAnnotFromFasta(), CCdCore::SetAccession(), CCdCore::SetClassicalParentAccessionNew(), CCdCore::SetOldRoot(), and CCdFromFasta::UpdateSourceId().

CGlobal_id_Base::TVersion & CGlobal_id_Base::SetVersion ( void  )
inline

Assign a value to Version data member.

Returns
Reference to the data value.

Definition at line 396 of file Global_id_.hpp.

References IsSetVersion(), m_set_State, m_Version, and CSerialObject::UnassignedByte().

Member Data Documentation

string CGlobal_id_Base::m_Accession
private

Definition at line 265 of file Global_id_.hpp.

Referenced by GetAccession(), ResetAccession(), and SetAccession().

string CGlobal_id_Base::m_Database
private

Definition at line 268 of file Global_id_.hpp.

Referenced by GetDatabase(), ResetDatabase(), and SetDatabase().

string CGlobal_id_Base::m_Release
private

Definition at line 266 of file Global_id_.hpp.

Referenced by GetRelease(), ResetRelease(), and SetRelease().

Uint4 CGlobal_id_Base::m_set_State[1]
private
int CGlobal_id_Base::m_Version
private

Definition at line 267 of file Global_id_.hpp.

Referenced by GetVersion(), ResetVersion(), and SetVersion().


The documentation for this class was generated from the following files:
Modified on Sat May 27 15:22:53 2017 by modify_doxy.py rev. 533848