NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | List of all members
CObject_id Class Reference

Represents ASN.1 type Object-id defined in file general.asn

Search Toolkit Book for CObject_id

#include <objects/general/Object_id.hpp>

+ Inheritance diagram for CObject_id:
+ Collaboration diagram for CObject_id:

Public Types

typedef Int8 TId8
 
- Public Types inherited from CObject_id_Base
enum  E_Choice { e_not_set = 0 , e_Id , e_Str }
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 3 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef int TId
 
typedef string TStr
 
- 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CObject_id (void)
 
 ~CObject_id (void)
 
bool Match (const CObject_id &oid2) const
 
bool SetAsMatchingTo (const CObject_id &oid2)
 
int Compare (const CObject_id &oid2) const
 
bool operator< (const CObject_id &id2) const
 
E_Choice GetIdType (TId8 &value) const
 
bool IsId8 (void) const
 
TId8 GetId8 (void) const
 
bool GetId8 (TId8 &value) const
 
void SetId8 (TId8 value)
 
bool IsGi (void) const
 
TGi GetGi (void) const
 
bool GetGi (TGi &value) const
 
void SetGi (TGi value)
 
void SetGi (TIntId value)
 
bool GetGi (TIntId &value) const
 
void SetStrOrId (CTempString str)
 
ostream & AsString (ostream &s) const
 
- Public Member Functions inherited from CObject_id_Base
 CObject_id_Base (void)
 
virtual ~CObject_id_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 IsId (void) const
 Check if variant Id is selected. More...
 
TId GetId (void) const
 Get the variant data. More...
 
TIdSetId (void)
 Select the variant. More...
 
void SetId (TId value)
 Select the variant and set its data. More...
 
bool IsStr (void) const
 Check if variant Str is selected. More...
 
const TStrGetStr (void) const
 Get the variant data. More...
 
TStrSetStr (void)
 Select the variant. More...
 
void SetStr (const TStr &value)
 Select the variant and set its data. 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 CObject_id_Base Tparent
 

Private Member Functions

 CObject_id (const CObject_id &)
 
CObject_idoperator= (const CObject_id &)
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject_id_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

Definition at line 53 of file Object_id.hpp.

Member Typedef Documentation

◆ TId8

Definition at line 83 of file Object_id.hpp.

◆ Tparent

Definition at line 55 of file Object_id.hpp.

Constructor & Destructor Documentation

◆ CObject_id() [1/2]

CObject_id::CObject_id ( void  )
inline

Definition at line 120 of file Object_id.hpp.

◆ ~CObject_id()

CObject_id::~CObject_id ( void  )

Definition at line 54 of file Object_id.cpp.

◆ CObject_id() [2/2]

CObject_id::CObject_id ( const CObject_id )
private

Member Function Documentation

◆ AsString()

ostream & CObject_id::AsString ( ostream &  s) const

◆ Compare()

int CObject_id::Compare ( const CObject_id oid2) const

◆ GetGi() [1/3]

bool CObject_id::GetGi ( TGi value) const
inline

Definition at line 150 of file Object_id.hpp.

References CObject_id_Base::GetId(), GetId8(), GI_FROM, CObject_id_Base::IsId(), and value.

◆ GetGi() [2/3]

bool CObject_id::GetGi ( TIntId value) const
inline

Definition at line 208 of file Object_id.hpp.

References CObject_id_Base::GetId(), GetId8(), CObject_id_Base::IsId(), and value.

◆ GetGi() [3/3]

TGi CObject_id::GetGi ( void  ) const
inline

Definition at line 179 of file Object_id.hpp.

References CObject_id_Base::GetId(), GetId8(), and GI_FROM.

◆ GetId8() [1/2]

bool CObject_id::GetId8 ( TId8 value) const
inline

Definition at line 134 of file Object_id.hpp.

References CObject_id_Base::e_Id, GetIdType(), and value.

◆ GetId8() [2/2]

CObject_id::TId8 CObject_id::GetId8 ( void  ) const

◆ GetIdType()

CObject_id::E_Choice CObject_id::GetIdType ( TId8 value) const

◆ IsGi()

bool CObject_id::IsGi ( void  ) const
inline

Definition at line 168 of file Object_id.hpp.

References CObject_id_Base::IsId(), and IsId8().

◆ IsId8()

bool CObject_id::IsId8 ( void  ) const
inline

Definition at line 141 of file Object_id.hpp.

References GetId8(), and value.

Referenced by IsGi().

◆ Match()

bool CObject_id::Match ( const CObject_id oid2) const

◆ operator<()

bool CObject_id::operator< ( const CObject_id id2) const
inline

Definition at line 126 of file Object_id.hpp.

References Compare().

◆ operator=()

CObject_id& CObject_id::operator= ( const CObject_id )
private

◆ SetAsMatchingTo()

bool CObject_id::SetAsMatchingTo ( const CObject_id oid2)

◆ SetGi() [1/2]

void CObject_id::SetGi ( TGi  value)
inline

Definition at line 190 of file Object_id.hpp.

References GI_TO, CObject_id_Base::SetId(), SetId8(), and value.

Referenced by CLocationListCtrl::GetIdFromForm().

◆ SetGi() [2/2]

void CObject_id::SetGi ( TIntId  value)
inline

Definition at line 201 of file Object_id.hpp.

References SetId8(), and value.

◆ SetId8()

void CObject_id::SetId8 ( TId8  value)

◆ SetStrOrId()

void CObject_id::SetStrOrId ( CTempString  str)

The documentation for this class was generated from the following files:
Modified on Thu Mar 28 17:11:57 2024 by modify_doxy.py rev. 669887