Search Toolkit Book for CSeqTable_multi_data_Base
CSeqTable_multi_data_Base –. More...
#include <objects/seqtable/SeqTable_multi_data_.hpp>
Inheritance diagram for CSeqTable_multi_data_Base:
Collaboration diagram for CSeqTable_multi_data_Base:
Public Types | |
| enum | E_Choice { e_not_set = 0 , e_Int , e_Real , e_String , e_Bytes , e_Common_string , e_Common_bytes , e_Bit , e_Loc , e_Id , e_Interval , e_Int_delta , e_Int_scaled , e_Real_scaled , e_Bit_bvector , e_Int1 , e_Int2 , e_Int8 } |
| Choice variants. More... | |
| enum | E_ChoiceStopper { e_MaxChoice = 18 } |
| Maximum+1 value of the choice variant enumerator. More... | |
| typedef vector< int > | TInt |
| typedef vector< double > | TReal |
| typedef vector< CStringUTF8 > | TString |
| typedef vector< vector< char > * > | TBytes |
| typedef CCommonString_table | TCommon_string |
| typedef CCommonBytes_table | TCommon_bytes |
| typedef vector< char > | TBit |
| typedef vector< CRef< CSeq_loc > > | TLoc |
| typedef vector< CRef< CSeq_id > > | TId |
| typedef vector< CRef< CSeq_interval > > | TInterval |
| typedef CSeqTable_multi_data | TInt_delta |
| typedef CScaled_int_multi_data | TInt_scaled |
| typedef CScaled_real_multi_data | TReal_scaled |
| typedef CBVector_data | TBit_bvector |
| typedef vector< char > | TInt1 |
| typedef vector< Int2 > | TInt2 |
| typedef vector< 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< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
Public Member Functions | |
| CSeqTable_multi_data_Base (void) | |
| virtual | ~CSeqTable_multi_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... | |
| const TInt & | GetInt (void) const |
| Get the variant data. More... | |
| TInt & | SetInt (void) |
| Select the variant. More... | |
| bool | IsReal (void) const |
| Check if variant Real is selected. More... | |
| const TReal & | GetReal (void) const |
| Get the variant data. More... | |
| TReal & | SetReal (void) |
| Select the variant. More... | |
| bool | IsString (void) const |
| Check if variant String is selected. More... | |
| const TString & | GetString (void) const |
| Get the variant data. More... | |
| TString & | SetString (void) |
| Select the variant. More... | |
| bool | IsBytes (void) const |
| Check if variant Bytes is selected. More... | |
| const TBytes & | GetBytes (void) const |
| Get the variant data. More... | |
| TBytes & | SetBytes (void) |
| Select the variant. More... | |
| bool | IsCommon_string (void) const |
| Check if variant Common_string is selected. More... | |
| const TCommon_string & | GetCommon_string (void) const |
| Get the variant data. More... | |
| TCommon_string & | SetCommon_string (void) |
| Select the variant. More... | |
| void | SetCommon_string (TCommon_string &value) |
| Select the variant and set its data. More... | |
| bool | IsCommon_bytes (void) const |
| Check if variant Common_bytes is selected. More... | |
| const TCommon_bytes & | GetCommon_bytes (void) const |
| Get the variant data. More... | |
| TCommon_bytes & | SetCommon_bytes (void) |
| Select the variant. More... | |
| void | SetCommon_bytes (TCommon_bytes &value) |
| Select the variant and set its data. More... | |
| bool | IsBit (void) const |
| Check if variant Bit is selected. More... | |
| const TBit & | GetBit (void) const |
| Get the variant data. More... | |
| TBit & | SetBit (void) |
| Select the variant. More... | |
| bool | IsLoc (void) const |
| Check if variant Loc is selected. More... | |
| const TLoc & | GetLoc (void) const |
| Get the variant data. More... | |
| TLoc & | SetLoc (void) |
| Select the variant. More... | |
| bool | IsId (void) const |
| Check if variant Id is selected. More... | |
| const TId & | GetId (void) const |
| Get the variant data. More... | |
| TId & | SetId (void) |
| Select the variant. More... | |
| bool | IsInterval (void) const |
| Check if variant Interval is selected. More... | |
| const TInterval & | GetInterval (void) const |
| Get the variant data. More... | |
| TInterval & | SetInterval (void) |
| Select the variant. More... | |
| bool | IsInt_delta (void) const |
| Check if variant Int_delta is selected. More... | |
| const TInt_delta & | GetInt_delta (void) const |
| Get the variant data. More... | |
| TInt_delta & | SetInt_delta (void) |
| Select the variant. More... | |
| void | SetInt_delta (TInt_delta &value) |
| Select the variant and set its data. More... | |
| bool | IsInt_scaled (void) const |
| Check if variant Int_scaled is selected. More... | |
| const TInt_scaled & | GetInt_scaled (void) const |
| Get the variant data. More... | |
| TInt_scaled & | SetInt_scaled (void) |
| Select the variant. More... | |
| void | SetInt_scaled (TInt_scaled &value) |
| Select the variant and set its data. More... | |
| bool | IsReal_scaled (void) const |
| Check if variant Real_scaled is selected. More... | |
| const TReal_scaled & | GetReal_scaled (void) const |
| Get the variant data. More... | |
| TReal_scaled & | SetReal_scaled (void) |
| Select the variant. More... | |
| void | SetReal_scaled (TReal_scaled &value) |
| Select the variant and set its data. More... | |
| bool | IsBit_bvector (void) const |
| Check if variant Bit_bvector is selected. More... | |
| const TBit_bvector & | GetBit_bvector (void) const |
| Get the variant data. More... | |
| TBit_bvector & | SetBit_bvector (void) |
| Select the variant. More... | |
| void | SetBit_bvector (TBit_bvector &value) |
| Select the variant and set its data. More... | |
| bool | IsInt1 (void) const |
| Check if variant Int1 is selected. More... | |
| const TInt1 & | GetInt1 (void) const |
| Get the variant data. More... | |
| TInt1 & | SetInt1 (void) |
| Select the variant. More... | |
| bool | IsInt2 (void) const |
| Check if variant Int2 is selected. More... | |
| const TInt2 & | GetInt2 (void) const |
| Get the variant data. More... | |
| TInt2 & | SetInt2 (void) |
| Select the variant. More... | |
| bool | IsInt8 (void) const |
| Check if variant Int8 is selected. More... | |
| const TInt8 & | GetInt8 (void) const |
| Get the variant data. More... | |
| TInt8 & | SetInt8 (void) |
| Select the variant. More... | |
| Public Member Functions inherited from CSerialObject | |
| CSerialObject (void) | |
| virtual | ~CSerialObject (void) |
| virtual const CTypeInfo * | GetThisTypeInfo (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 string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (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... | |
| CObject & | operator= (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 | |
| CSeqTable_multi_data_Base (const CSeqTable_multi_data_Base &) | |
| CSeqTable_multi_data_Base & | operator= (const CSeqTable_multi_data_Base &) |
| void | DoSelect (E_Choice index, CObjectMemoryPool *pool=0) |
Private Attributes | |
| E_Choice | m_choice |
| union { | |
| NCBI_NS_NCBI::CUnionBuffer< TInt > CSeqTable_multi_data_Base::m_Int | |
| NCBI_NS_NCBI::CUnionBuffer< TReal > CSeqTable_multi_data_Base::m_Real | |
| NCBI_NS_NCBI::CUnionBuffer< TString > CSeqTable_multi_data_Base::m_String | |
| NCBI_NS_NCBI::CUnionBuffer< TBytes > CSeqTable_multi_data_Base::m_Bytes | |
| NCBI_NS_NCBI::CUnionBuffer< TBit > CSeqTable_multi_data_Base::m_Bit | |
| NCBI_NS_NCBI::CUnionBuffer< TLoc > CSeqTable_multi_data_Base::m_Loc | |
| NCBI_NS_NCBI::CUnionBuffer< TId > CSeqTable_multi_data_Base::m_Id | |
| NCBI_NS_NCBI::CUnionBuffer< TInterval > CSeqTable_multi_data_Base::m_Interval | |
| NCBI_NS_NCBI::CUnionBuffer< TInt1 > CSeqTable_multi_data_Base::m_Int1 | |
| NCBI_NS_NCBI::CUnionBuffer< TInt2 > CSeqTable_multi_data_Base::m_Int2 | |
| NCBI_NS_NCBI::CUnionBuffer< TInt8 > CSeqTable_multi_data_Base::m_Int8 | |
| NCBI_NS_NCBI::CSerialObject * CSeqTable_multi_data_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
Definition at line 85 of file SeqTable_multi_data_.hpp.
The documentation for this class was generated from the following files:
- include/objects/seqtable/SeqTable_multi_data_.hpp
- src/objects/seqtable/SeqTable_multi_data_.cpp
