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

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

Search Toolkit Book for CPerson_id

#include <objects/general/Person_id.hpp>

+ Inheritance diagram for CPerson_id:
+ Collaboration diagram for CPerson_id:

Public Types

enum  ETypeLabel { eGenbank , eEmbl }
 
- Public Types inherited from CPerson_id_Base
enum  E_Choice {
  e_not_set = 0 , e_Dbtag , e_Name , e_Ml ,
  e_Str , e_Consortium
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 6 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef CDbtag TDbtag
 
typedef CName_std TName
 
typedef string TMl
 
typedef string TStr
 
typedef string TConsortium
 
- 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

 CPerson_id (void)
 
 ~CPerson_id (void)
 
void GetLabel (string *label, ETypeLabel type=eGenbank) const
 
- Public Member Functions inherited from CPerson_id_Base
 CPerson_id_Base (void)
 
virtual ~CPerson_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 IsDbtag (void) const
 Check if variant Dbtag is selected. More...
 
const TDbtagGetDbtag (void) const
 Get the variant data. More...
 
TDbtagSetDbtag (void)
 Select the variant. More...
 
void SetDbtag (TDbtag &value)
 Select the variant and set its data. More...
 
bool IsName (void) const
 Check if variant Name is selected. More...
 
const TNameGetName (void) const
 Get the variant data. More...
 
TNameSetName (void)
 Select the variant. More...
 
void SetName (TName &value)
 Select the variant and set its data. More...
 
bool IsMl (void) const
 Check if variant Ml is selected. More...
 
const TMlGetMl (void) const
 Get the variant data. More...
 
TMlSetMl (void)
 Select the variant. More...
 
void SetMl (const TMl &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...
 
bool IsConsortium (void) const
 Check if variant Consortium is selected. More...
 
const TConsortiumGetConsortium (void) const
 Get the variant data. More...
 
TConsortiumSetConsortium (void)
 Select the variant. More...
 
void SetConsortium (const TConsortium &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 CPerson_id_Base Tparent
 

Private Member Functions

 CPerson_id (const CPerson_id &value)
 
CPerson_idoperator= (const CPerson_id &value)
 

Additional Inherited Members

- Static Public Member Functions inherited from CPerson_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 50 of file Person_id.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 52 of file Person_id.hpp.

Member Enumeration Documentation

◆ ETypeLabel

Enumerator
eGenbank 
eEmbl 

Definition at line 59 of file Person_id.hpp.

Constructor & Destructor Documentation

◆ CPerson_id() [1/2]

CPerson_id::CPerson_id ( void  )
inline

Definition at line 82 of file Person_id.hpp.

◆ ~CPerson_id()

CPerson_id::~CPerson_id ( void  )

Definition at line 52 of file Person_id.cpp.

◆ CPerson_id() [2/2]

CPerson_id::CPerson_id ( const CPerson_id value)
private

Member Function Documentation

◆ GetLabel()

void CPerson_id::GetLabel ( string label,
ETypeLabel  type = eGenbank 
) const

◆ operator=()

CPerson_id& CPerson_id::operator= ( const CPerson_id value)
private

The documentation for this class was generated from the following files:
Modified on Wed Apr 24 14:11:06 2024 by modify_doxy.py rev. 669887