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

Represents ASN.1 type ID1server-back defined in file id1.asn

Search Toolkit Book for CID1server_back

@ID1server_back.hpp User-defined methods of the data storage class. More...

#include <objects/id1/ID1server_back.hpp>

+ Inheritance diagram for CID1server_back:
+ Collaboration diagram for CID1server_back:

Public Member Functions

 CID1server_back (void)
 
 ~CID1server_back (void)
 
string GetErrorString (void) const
 
- Public Member Functions inherited from CID1server_back_Base
 CID1server_back_Base (void)
 
virtual ~CID1server_back_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 IsInit (void) const
 Check if variant Init is selected. More...
 
void SetInit (void)
 Select the variant. More...
 
bool IsError (void) const
 Check if variant Error is selected. More...
 
TError GetError (void) const
 Get the variant data. More...
 
TErrorSetError (void)
 Select the variant. More...
 
void SetError (TError value)
 Select the variant and set its data. More...
 
bool IsGotgi (void) const
 Check if variant Gotgi is selected. More...
 
TGotgi GetGotgi (void) const
 Get the variant data. More...
 
TGotgiSetGotgi (void)
 Select the variant. More...
 
void SetGotgi (TGotgi value)
 Select the variant and set its data. More...
 
bool IsGotseqentry (void) const
 Check if variant Gotseqentry is selected. More...
 
const TGotseqentryGetGotseqentry (void) const
 Get the variant data. More...
 
TGotseqentrySetGotseqentry (void)
 Select the variant. More...
 
void SetGotseqentry (TGotseqentry &value)
 Select the variant and set its data. More...
 
bool IsGotdeadseqentry (void) const
 Check if variant Gotdeadseqentry is selected. More...
 
const TGotdeadseqentryGetGotdeadseqentry (void) const
 Get the variant data. More...
 
TGotdeadseqentrySetGotdeadseqentry (void)
 Select the variant. More...
 
void SetGotdeadseqentry (TGotdeadseqentry &value)
 Select the variant and set its data. More...
 
bool IsFini (void) const
 Check if variant Fini is selected. More...
 
void SetFini (void)
 Select the variant. More...
 
bool IsGistate (void) const
 Check if variant Gistate is selected. More...
 
TGistate GetGistate (void) const
 Get the variant data. More...
 
TGistateSetGistate (void)
 Select the variant. More...
 
void SetGistate (TGistate value)
 Select the variant and set its data. More...
 
bool IsIds (void) const
 Check if variant Ids is selected. More...
 
const TIdsGetIds (void) const
 Get the variant data. More...
 
TIdsSetIds (void)
 Select the variant. More...
 
bool IsGihist (void) const
 Check if variant Gihist is selected. More...
 
const TGihistGetGihist (void) const
 Get the variant data. More...
 
TGihistSetGihist (void)
 Select the variant. More...
 
bool IsGirevhist (void) const
 Check if variant Girevhist is selected. More...
 
const TGirevhistGetGirevhist (void) const
 Get the variant data. More...
 
TGirevhistSetGirevhist (void)
 Select the variant. More...
 
bool IsGotsewithinfo (void) const
 Check if variant Gotsewithinfo is selected. More...
 
const TGotsewithinfoGetGotsewithinfo (void) const
 Get the variant data. More...
 
TGotsewithinfoSetGotsewithinfo (void)
 Select the variant. More...
 
void SetGotsewithinfo (TGotsewithinfo &value)
 Select the variant and set its data. More...
 
bool IsGotblobinfo (void) const
 Check if variant Gotblobinfo is selected. More...
 
const TGotblobinfoGetGotblobinfo (void) const
 Get the variant data. More...
 
TGotblobinfoSetGotblobinfo (void)
 Select the variant. More...
 
void SetGotblobinfo (TGotblobinfo &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 GetErrorString (TError error)
 
- Static Public Member Functions inherited from CID1server_back_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)
 

Private Types

typedef CID1server_back_Base Tparent
 

Private Member Functions

 CID1server_back (const CID1server_back &value)
 
CID1server_backoperator= (const CID1server_back &value)
 

Additional Inherited Members

- Public Types inherited from CID1server_back_Base
enum  E_Choice {
  e_not_set = 0 , e_Init , e_Error , e_Gotgi ,
  e_Gotseqentry , e_Gotdeadseqentry , e_Fini , e_Gistate ,
  e_Ids , e_Gihist , e_Girevhist , e_Gotsewithinfo ,
  e_Gotblobinfo
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 13 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef int TError
 
typedef NCBI_NS_NCBI::TGi TGotgi
 
typedef CSeq_entry TGotseqentry
 
typedef CSeq_entry TGotdeadseqentry
 
typedef int TGistate
 
typedef list< CRef< CSeq_id > > TIds
 
typedef list< CRef< CID1Seq_hist > > TGihist
 
typedef list< CRef< CID1Seq_hist > > TGirevhist
 
typedef CID1SeqEntry_info TGotsewithinfo
 
typedef CID1blob_info TGotblobinfo
 
- 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...
 
- 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

@ID1server_back.hpp User-defined methods of the data storage class.

This file was originally generated by application DATATOOL using the following specifications: 'id1.asn'.

New methods or data members can be added to it if needed. See also: ID1server_back_.hpp

Definition at line 53 of file ID1server_back.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file ID1server_back.hpp.

Constructor & Destructor Documentation

◆ CID1server_back() [1/2]

CID1server_back::CID1server_back ( void  )
inline

Definition at line 77 of file ID1server_back.hpp.

◆ ~CID1server_back()

CID1server_back::~CID1server_back ( void  )

Definition at line 50 of file ID1server_back.cpp.

◆ CID1server_back() [2/2]

CID1server_back::CID1server_back ( const CID1server_back value)
private

Member Function Documentation

◆ GetErrorString() [1/2]

string CID1server_back::GetErrorString ( TError  error)
static

Definition at line 54 of file ID1server_back.cpp.

Referenced by CID1Client::Ask().

◆ GetErrorString() [2/2]

string CID1server_back::GetErrorString ( void  ) const
inline

◆ operator=()

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

The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:09:52 2024 by modify_doxy.py rev. 669887