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

Represents ASN.1 type Field-type defined in file macro.asn

Search Toolkit Book for CField_type_Base

CField_type_Base –. More...

#include <objects/macro/Field_type_.hpp>

+ Inheritance diagram for CField_type_Base:
+ Collaboration diagram for CField_type_Base:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_Source_qual , e_Feature_field , e_Rna_field ,
  e_Cds_gene_prot , e_Molinfo_field , e_Pub , e_Struc_comment_field ,
  e_Misc , e_Dblink
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 10 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef CSource_qual_choice TSource_qual
 
typedef CFeature_field TFeature_field
 
typedef CRna_qual TRna_field
 
typedef ECDSGeneProt_field TCds_gene_prot
 
typedef CMolinfo_field TMolinfo_field
 
typedef EPublication_field TPub
 
typedef CStructured_comment_field TStruc_comment_field
 
typedef EMisc_field TMisc
 
typedef EDBLink_field_type TDblink
 
- 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

 CField_type_Base (void)
 
virtual ~CField_type_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 IsSource_qual (void) const
 Check if variant Source_qual is selected. More...
 
const TSource_qualGetSource_qual (void) const
 Get the variant data. More...
 
TSource_qualSetSource_qual (void)
 Select the variant. More...
 
void SetSource_qual (TSource_qual &value)
 Select the variant and set its data. More...
 
bool IsFeature_field (void) const
 Check if variant Feature_field is selected. More...
 
const TFeature_fieldGetFeature_field (void) const
 Get the variant data. More...
 
TFeature_fieldSetFeature_field (void)
 Select the variant. More...
 
void SetFeature_field (TFeature_field &value)
 Select the variant and set its data. More...
 
bool IsRna_field (void) const
 Check if variant Rna_field is selected. More...
 
const TRna_fieldGetRna_field (void) const
 Get the variant data. More...
 
TRna_fieldSetRna_field (void)
 Select the variant. More...
 
void SetRna_field (TRna_field &value)
 Select the variant and set its data. More...
 
bool IsCds_gene_prot (void) const
 Check if variant Cds_gene_prot is selected. More...
 
TCds_gene_prot GetCds_gene_prot (void) const
 Get the variant data. More...
 
TCds_gene_protSetCds_gene_prot (void)
 Select the variant. More...
 
void SetCds_gene_prot (TCds_gene_prot value)
 Select the variant and set its data. More...
 
bool IsMolinfo_field (void) const
 Check if variant Molinfo_field is selected. More...
 
const TMolinfo_fieldGetMolinfo_field (void) const
 Get the variant data. More...
 
TMolinfo_fieldSetMolinfo_field (void)
 Select the variant. More...
 
void SetMolinfo_field (TMolinfo_field &value)
 Select the variant and set its data. More...
 
bool IsPub (void) const
 Check if variant Pub is selected. More...
 
TPub GetPub (void) const
 Get the variant data. More...
 
TPubSetPub (void)
 Select the variant. More...
 
void SetPub (TPub value)
 Select the variant and set its data. More...
 
bool IsStruc_comment_field (void) const
 Check if variant Struc_comment_field is selected. More...
 
const TStruc_comment_fieldGetStruc_comment_field (void) const
 Get the variant data. More...
 
TStruc_comment_fieldSetStruc_comment_field (void)
 Select the variant. More...
 
void SetStruc_comment_field (TStruc_comment_field &value)
 Select the variant and set its data. More...
 
bool IsMisc (void) const
 Check if variant Misc is selected. More...
 
TMisc GetMisc (void) const
 Get the variant data. More...
 
TMiscSetMisc (void)
 Select the variant. More...
 
void SetMisc (TMisc value)
 Select the variant and set its data. More...
 
bool IsDblink (void) const
 Check if variant Dblink is selected. More...
 
TDblink GetDblink (void) const
 Get the variant data. More...
 
TDblinkSetDblink (void)
 Select the variant. More...
 
void SetDblink (TDblink 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
 

Static Public Member Functions

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)
 

Private Types

typedef CSerialObject Tparent
 

Private Member Functions

 CField_type_Base (const CField_type_Base &)
 
CField_type_Baseoperator= (const CField_type_Base &)
 
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
union {
   TCds_gene_prot   CField_type_Base::m_Cds_gene_prot
 
   TPub   CField_type_Base::m_Pub
 
   TMisc   CField_type_Base::m_Misc
 
   TDblink   CField_type_Base::m_Dblink
 
   NCBI_NS_NCBI::CSerialObject *   CField_type_Base::m_object
 
}; 
 

Static Private Attributes

static const char *const sm_SelectionNames []
 

Additional Inherited Members

- 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

CField_type_Base –.

Definition at line 83 of file Field_type_.hpp.


The documentation for this class was generated from the following files:
Modified on Sat Apr 13 11:45:35 2024 by modify_doxy.py rev. 669887