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

Represents ASN.1 type SeqTable-single-data defined in file seqtable.asn

Search Toolkit Book for CSeqTable_single_data

#include <objects/seqtable/SeqTable_single_data.hpp>

+ Inheritance diagram for CSeqTable_single_data:
+ Collaboration diagram for CSeqTable_single_data:

Public Member Functions

 CSeqTable_single_data (void)
 
 ~CSeqTable_single_data (void)
 
E_Choice GetValueType (void) const
 
bool CanGetInt (void) const
 
size_t GetIntSize (void) const
 
bool CanGetReal (void) const
 
void GetValue (bool &v) const
 
void GetValue (Int1 &v) const
 
void GetValue (Int2 &v) const
 
void GetValue (int &v) const
 
void GetValue (Int8 &v) const
 
void GetValue (double &v) const
 
void GetValue (string &v) const
 
void GetValue (TBytes &v) const
 
void ThrowConversionError (const char *type_name) const
 
- Public Member Functions inherited from CSeqTable_single_data_Base
 CSeqTable_single_data_Base (void)
 
virtual ~CSeqTable_single_data_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 IsInt (void) const
 Check if variant Int is selected. More...
 
TInt GetInt (void) const
 Get the variant data. More...
 
TIntSetInt (void)
 Select the variant. More...
 
void SetInt (TInt value)
 Select the variant and set its data. More...
 
bool IsReal (void) const
 Check if variant Real is selected. More...
 
TReal GetReal (void) const
 Get the variant data. More...
 
TRealSetReal (void)
 Select the variant. More...
 
void SetReal (TReal value)
 Select the variant and set its data. More...
 
bool IsString (void) const
 Check if variant String is selected. More...
 
const TStringGetString (void) const
 Get the variant data. More...
 
TStringSetString (void)
 Select the variant. More...
 
void SetString (const TString &value)
 Select the variant and set its data. More...
 
bool IsBytes (void) const
 Check if variant Bytes is selected. More...
 
const TBytesGetBytes (void) const
 Get the variant data. More...
 
TBytesSetBytes (void)
 Select the variant. More...
 
bool IsBit (void) const
 Check if variant Bit is selected. More...
 
TBit GetBit (void) const
 Get the variant data. More...
 
TBitSetBit (void)
 Select the variant. More...
 
void SetBit (TBit value)
 Select the variant and set its data. More...
 
bool IsLoc (void) const
 Check if variant Loc is selected. More...
 
const TLocGetLoc (void) const
 Get the variant data. More...
 
TLocSetLoc (void)
 Select the variant. More...
 
void SetLoc (TLoc &value)
 Select the variant and set its data. More...
 
bool IsId (void) const
 Check if variant Id is selected. More...
 
const TIdGetId (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 IsInterval (void) const
 Check if variant Interval is selected. More...
 
const TIntervalGetInterval (void) const
 Get the variant data. More...
 
TIntervalSetInterval (void)
 Select the variant. More...
 
void SetInterval (TInterval &value)
 Select the variant and set its data. More...
 
bool IsInt8 (void) const
 Check if variant Int8 is selected. More...
 
TInt8 GetInt8 (void) const
 Get the variant data. More...
 
TInt8SetInt8 (void)
 Select the variant. More...
 
void SetInt8 (TInt8 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 void ThrowOverflowError (Int8 value, const char *type_name)
 
- Static Public Member Functions inherited from CSeqTable_single_data_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 CSeqTable_single_data_Base Tparent
 

Private Member Functions

 CSeqTable_single_data (const CSeqTable_single_data &value)
 
CSeqTable_single_dataoperator= (const CSeqTable_single_data &value)
 

Additional Inherited Members

- Public Types inherited from CSeqTable_single_data_Base
enum  E_Choice {
  e_not_set = 0 , e_Int , e_Real , e_String ,
  e_Bytes , e_Bit , e_Loc , e_Id ,
  e_Interval , e_Int8
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 10 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef int TInt
 
typedef double TReal
 
typedef CStringUTF8 TString
 
typedef vector< char > TBytes
 
typedef bool TBit
 
typedef CSeq_loc TLoc
 
typedef CSeq_id TId
 
typedef CSeq_interval TInterval
 
typedef Int8 TInt8
 
- 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

Definition at line 53 of file SeqTable_single_data.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file SeqTable_single_data.hpp.

Constructor & Destructor Documentation

◆ CSeqTable_single_data() [1/2]

CSeqTable_single_data::CSeqTable_single_data ( void  )
inline

Definition at line 106 of file SeqTable_single_data.hpp.

◆ ~CSeqTable_single_data()

CSeqTable_single_data::~CSeqTable_single_data ( void  )

Definition at line 50 of file SeqTable_single_data.cpp.

◆ CSeqTable_single_data() [2/2]

CSeqTable_single_data::CSeqTable_single_data ( const CSeqTable_single_data value)
private

Member Function Documentation

◆ CanGetInt()

bool CSeqTable_single_data::CanGetInt ( void  ) const
inline

◆ CanGetReal()

bool CSeqTable_single_data::CanGetReal ( void  ) const
inline

Definition at line 79 of file SeqTable_single_data.hpp.

References CSeqTable_single_data_Base::IsReal().

◆ GetIntSize()

size_t CSeqTable_single_data::GetIntSize ( void  ) const
inline

◆ GetValue() [1/8]

void CSeqTable_single_data::GetValue ( bool v) const

◆ GetValue() [2/8]

void CSeqTable_single_data::GetValue ( double &  v) const

◆ GetValue() [3/8]

void CSeqTable_single_data::GetValue ( int v) const

◆ GetValue() [4/8]

void CSeqTable_single_data::GetValue ( Int1 v) const

◆ GetValue() [5/8]

void CSeqTable_single_data::GetValue ( Int2 v) const

◆ GetValue() [6/8]

void CSeqTable_single_data::GetValue ( Int8 v) const

◆ GetValue() [7/8]

void CSeqTable_single_data::GetValue ( string v) const

◆ GetValue() [8/8]

void CSeqTable_single_data::GetValue ( TBytes v) const

◆ GetValueType()

E_Choice CSeqTable_single_data::GetValueType ( void  ) const
inline

Definition at line 62 of file SeqTable_single_data.hpp.

References CSeqTable_single_data_Base::Which().

◆ operator=()

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

◆ ThrowConversionError()

void CSeqTable_single_data::ThrowConversionError ( const char *  type_name) const

◆ ThrowOverflowError()

void CSeqTable_single_data::ThrowOverflowError ( Int8  value,
const char *  type_name 
)
static

Definition at line 55 of file SeqTable_single_data.cpp.

References NCBI_THROW_FMT, type_name(), and rapidjson::value.

Referenced by sx_DownCast().


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