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 E2Reply defined in file entrez2.asn

Search Toolkit Book for CE2Reply_Base

CE2Reply_Base –. More...

#include <objects/entrez2/E2Reply_.hpp>

+ Inheritance diagram for CE2Reply_Base:
+ Collaboration diagram for CE2Reply_Base:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_Error , e_Get_info , e_Eval_boolean ,
  e_Get_docsum , e_Get_term_pos , e_Get_term_list , e_Get_term_hierarchy ,
  e_Get_links , e_Get_linked , e_Get_link_counts
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 11 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef string TError
 
typedef CEntrez2_info TGet_info
 
typedef CEntrez2_boolean_reply TEval_boolean
 
typedef CEntrez2_docsum_list TGet_docsum
 
typedef int TGet_term_pos
 
typedef CEntrez2_term_list TGet_term_list
 
typedef CEntrez2_hier_node TGet_term_hierarchy
 
typedef CEntrez2_link_set TGet_links
 
typedef CEntrez2_id_list TGet_linked
 
typedef CEntrez2_link_count_list TGet_link_counts
 
- 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

 CE2Reply_Base (void)
 
virtual ~CE2Reply_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 IsError (void) const
 Check if variant Error is selected. More...
 
const TErrorGetError (void) const
 Get the variant data. More...
 
TErrorSetError (void)
 Select the variant. More...
 
void SetError (const TError &value)
 Select the variant and set its data. More...
 
bool IsGet_info (void) const
 Check if variant Get_info is selected. More...
 
const TGet_infoGetGet_info (void) const
 Get the variant data. More...
 
TGet_infoSetGet_info (void)
 Select the variant. More...
 
void SetGet_info (TGet_info &value)
 Select the variant and set its data. More...
 
bool IsEval_boolean (void) const
 Check if variant Eval_boolean is selected. More...
 
const TEval_booleanGetEval_boolean (void) const
 Get the variant data. More...
 
TEval_booleanSetEval_boolean (void)
 Select the variant. More...
 
void SetEval_boolean (TEval_boolean &value)
 Select the variant and set its data. More...
 
bool IsGet_docsum (void) const
 Check if variant Get_docsum is selected. More...
 
const TGet_docsumGetGet_docsum (void) const
 Get the variant data. More...
 
TGet_docsumSetGet_docsum (void)
 Select the variant. More...
 
void SetGet_docsum (TGet_docsum &value)
 Select the variant and set its data. More...
 
bool IsGet_term_pos (void) const
 Check if variant Get_term_pos is selected. More...
 
TGet_term_pos GetGet_term_pos (void) const
 Get the variant data. More...
 
TGet_term_posSetGet_term_pos (void)
 Select the variant. More...
 
void SetGet_term_pos (TGet_term_pos value)
 Select the variant and set its data. More...
 
bool IsGet_term_list (void) const
 Check if variant Get_term_list is selected. More...
 
const TGet_term_listGetGet_term_list (void) const
 Get the variant data. More...
 
TGet_term_listSetGet_term_list (void)
 Select the variant. More...
 
void SetGet_term_list (TGet_term_list &value)
 Select the variant and set its data. More...
 
bool IsGet_term_hierarchy (void) const
 Check if variant Get_term_hierarchy is selected. More...
 
const TGet_term_hierarchyGetGet_term_hierarchy (void) const
 Get the variant data. More...
 
TGet_term_hierarchySetGet_term_hierarchy (void)
 Select the variant. More...
 
void SetGet_term_hierarchy (TGet_term_hierarchy &value)
 Select the variant and set its data. More...
 
bool IsGet_links (void) const
 Check if variant Get_links is selected. More...
 
const TGet_linksGetGet_links (void) const
 Get the variant data. More...
 
TGet_linksSetGet_links (void)
 Select the variant. More...
 
void SetGet_links (TGet_links &value)
 Select the variant and set its data. More...
 
bool IsGet_linked (void) const
 Check if variant Get_linked is selected. More...
 
const TGet_linkedGetGet_linked (void) const
 Get the variant data. More...
 
TGet_linkedSetGet_linked (void)
 Select the variant. More...
 
void SetGet_linked (TGet_linked &value)
 Select the variant and set its data. More...
 
bool IsGet_link_counts (void) const
 Check if variant Get_link_counts is selected. More...
 
const TGet_link_countsGetGet_link_counts (void) const
 Get the variant data. More...
 
TGet_link_countsSetGet_link_counts (void)
 Select the variant. More...
 
void SetGet_link_counts (TGet_link_counts &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

 CE2Reply_Base (const CE2Reply_Base &)
 
CE2Reply_Baseoperator= (const CE2Reply_Base &)
 
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
union {
   TGet_term_pos   CE2Reply_Base::m_Get_term_pos
 
   NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string >   CE2Reply_Base::m_string
 
   NCBI_NS_NCBI::CSerialObject *   CE2Reply_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

CE2Reply_Base –.

Definition at line 83 of file E2Reply_.hpp.


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