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

Search Toolkit Book for CPC_InfoData_Base::C_Value

Data Value. More...

#include <objects/pcsubstance/PC_InfoData_.hpp>

+ Inheritance diagram for CPC_InfoData_Base::C_Value:
+ Collaboration diagram for CPC_InfoData_Base::C_Value:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_Bval , e_Bvec , e_Ival ,
  e_Ivec , e_Fval , e_Fvec , e_Sval ,
  e_Slist , e_Date , e_Binary , e_Bitlist
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 12 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef bool TBval
 
typedef vector< char > TBvec
 
typedef int TIval
 
typedef vector< intTIvec
 
typedef double TFval
 
typedef vector< double > TFvec
 
typedef string TSval
 
typedef list< stringTSlist
 
typedef CDate TDate
 
typedef vector< char > TBinary
 
typedef CBitString TBitlist
 
- 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

 C_Value (void)
 
 ~C_Value (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
void Reset (void)
 Reset the whole object. More...
 
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 IsBval (void) const
 Check if variant Bval is selected. More...
 
TBval GetBval (void) const
 Get the variant data. More...
 
TBvalSetBval (void)
 Select the variant. More...
 
void SetBval (TBval value)
 Select the variant and set its data. More...
 
bool IsBvec (void) const
 Check if variant Bvec is selected. More...
 
const TBvecGetBvec (void) const
 Get the variant data. More...
 
TBvecSetBvec (void)
 Select the variant. More...
 
bool IsIval (void) const
 Check if variant Ival is selected. More...
 
TIval GetIval (void) const
 Get the variant data. More...
 
TIvalSetIval (void)
 Select the variant. More...
 
void SetIval (TIval value)
 Select the variant and set its data. More...
 
bool IsIvec (void) const
 Check if variant Ivec is selected. More...
 
const TIvecGetIvec (void) const
 Get the variant data. More...
 
TIvecSetIvec (void)
 Select the variant. More...
 
bool IsFval (void) const
 Check if variant Fval is selected. More...
 
TFval GetFval (void) const
 Get the variant data. More...
 
TFvalSetFval (void)
 Select the variant. More...
 
void SetFval (TFval value)
 Select the variant and set its data. More...
 
bool IsFvec (void) const
 Check if variant Fvec is selected. More...
 
const TFvecGetFvec (void) const
 Get the variant data. More...
 
TFvecSetFvec (void)
 Select the variant. More...
 
bool IsSval (void) const
 Check if variant Sval is selected. More...
 
const TSvalGetSval (void) const
 Get the variant data. More...
 
TSvalSetSval (void)
 Select the variant. More...
 
void SetSval (const TSval &value)
 Select the variant and set its data. More...
 
bool IsSlist (void) const
 Check if variant Slist is selected. More...
 
const TSlistGetSlist (void) const
 Get the variant data. More...
 
TSlistSetSlist (void)
 Select the variant. More...
 
bool IsDate (void) const
 Check if variant Date is selected. More...
 
const TDateGetDate (void) const
 Get the variant data. More...
 
TDateSetDate (void)
 Select the variant. More...
 
void SetDate (TDate &value)
 Select the variant and set its data. More...
 
bool IsBinary (void) const
 Check if variant Binary is selected. More...
 
const TBinaryGetBinary (void) const
 Get the variant data. More...
 
TBinarySetBinary (void)
 Select the variant. More...
 
bool IsBitlist (void) const
 Check if variant Bitlist is selected. More...
 
const TBitlistGetBitlist (void) const
 Get the variant data. More...
 
TBitlistSetBitlist (void)
 Select the variant. 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

 C_Value (const C_Value &)
 
C_Valueoperator= (const C_Value &)
 
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
union {
   TBval   CPC_InfoData_Base::C_Value::m_Bval
 
   NCBI_NS_NCBI::CUnionBuffer< TBvec >   CPC_InfoData_Base::C_Value::m_Bvec
 
   TIval   CPC_InfoData_Base::C_Value::m_Ival
 
   NCBI_NS_NCBI::CUnionBuffer< TIvec >   CPC_InfoData_Base::C_Value::m_Ivec
 
   TFval   CPC_InfoData_Base::C_Value::m_Fval
 
   NCBI_NS_NCBI::CUnionBuffer< TFvec >   CPC_InfoData_Base::C_Value::m_Fvec
 
   NCBI_NS_NCBI::CUnionBuffer< TSlist >   CPC_InfoData_Base::C_Value::m_Slist
 
   NCBI_NS_NCBI::CUnionBuffer< TBinary >   CPC_InfoData_Base::C_Value::m_Binary
 
   NCBI_NS_NCBI::CUnionBuffer< TBitlist >   CPC_InfoData_Base::C_Value::m_Bitlist
 
   NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string >   CPC_InfoData_Base::C_Value::m_string
 
   NCBI_NS_NCBI::CSerialObject *   CPC_InfoData_Base::C_Value::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

Data Value.

C_Value

Definition at line 98 of file PC_InfoData_.hpp.


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