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 Seq-data defined in file seq.asn

Search Toolkit Book for CSeq_data_Base

*** Various internal sequence representations ************ * all are controlled, fixed length forms sequence representations More...

#include <objects/seq/Seq_data_.hpp>

+ Inheritance diagram for CSeq_data_Base:
+ Collaboration diagram for CSeq_data_Base:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_Iupacna , e_Iupacaa , e_Ncbi2na ,
  e_Ncbi4na , e_Ncbi8na , e_Ncbipna , e_Ncbi8aa ,
  e_Ncbieaa , e_Ncbipaa , e_Ncbistdaa , e_Gap
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 12 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef CIUPACna TIupacna
 
typedef CIUPACaa TIupacaa
 
typedef CNCBI2na TNcbi2na
 
typedef CNCBI4na TNcbi4na
 
typedef CNCBI8na TNcbi8na
 
typedef CNCBIpna TNcbipna
 
typedef CNCBI8aa TNcbi8aa
 
typedef CNCBIeaa TNcbieaa
 
typedef CNCBIpaa TNcbipaa
 
typedef CNCBIstdaa TNcbistdaa
 
typedef CSeq_gap TGap
 
- 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

 CSeq_data_Base (void)
 
virtual ~CSeq_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 IsIupacna (void) const
 Check if variant Iupacna is selected. More...
 
const TIupacnaGetIupacna (void) const
 Get the variant data. More...
 
TIupacnaSetIupacna (void)
 Select the variant. More...
 
void SetIupacna (const TIupacna &value)
 Select the variant and set its data. More...
 
bool IsIupacaa (void) const
 Check if variant Iupacaa is selected. More...
 
const TIupacaaGetIupacaa (void) const
 Get the variant data. More...
 
TIupacaaSetIupacaa (void)
 Select the variant. More...
 
void SetIupacaa (const TIupacaa &value)
 Select the variant and set its data. More...
 
bool IsNcbi2na (void) const
 Check if variant Ncbi2na is selected. More...
 
const TNcbi2naGetNcbi2na (void) const
 Get the variant data. More...
 
TNcbi2naSetNcbi2na (void)
 Select the variant. More...
 
bool IsNcbi4na (void) const
 Check if variant Ncbi4na is selected. More...
 
const TNcbi4naGetNcbi4na (void) const
 Get the variant data. More...
 
TNcbi4naSetNcbi4na (void)
 Select the variant. More...
 
bool IsNcbi8na (void) const
 Check if variant Ncbi8na is selected. More...
 
const TNcbi8naGetNcbi8na (void) const
 Get the variant data. More...
 
TNcbi8naSetNcbi8na (void)
 Select the variant. More...
 
bool IsNcbipna (void) const
 Check if variant Ncbipna is selected. More...
 
const TNcbipnaGetNcbipna (void) const
 Get the variant data. More...
 
TNcbipnaSetNcbipna (void)
 Select the variant. More...
 
bool IsNcbi8aa (void) const
 Check if variant Ncbi8aa is selected. More...
 
const TNcbi8aaGetNcbi8aa (void) const
 Get the variant data. More...
 
TNcbi8aaSetNcbi8aa (void)
 Select the variant. More...
 
bool IsNcbieaa (void) const
 Check if variant Ncbieaa is selected. More...
 
const TNcbieaaGetNcbieaa (void) const
 Get the variant data. More...
 
TNcbieaaSetNcbieaa (void)
 Select the variant. More...
 
void SetNcbieaa (const TNcbieaa &value)
 Select the variant and set its data. More...
 
bool IsNcbipaa (void) const
 Check if variant Ncbipaa is selected. More...
 
const TNcbipaaGetNcbipaa (void) const
 Get the variant data. More...
 
TNcbipaaSetNcbipaa (void)
 Select the variant. More...
 
bool IsNcbistdaa (void) const
 Check if variant Ncbistdaa is selected. More...
 
const TNcbistdaaGetNcbistdaa (void) const
 Get the variant data. More...
 
TNcbistdaaSetNcbistdaa (void)
 Select the variant. More...
 
bool IsGap (void) const
 Check if variant Gap is selected. More...
 
const TGapGetGap (void) const
 Get the variant data. More...
 
TGapSetGap (void)
 Select the variant. More...
 
void SetGap (TGap &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

 CSeq_data_Base (const CSeq_data_Base &)
 
CSeq_data_Baseoperator= (const CSeq_data_Base &)
 
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
union {
   NCBI_NS_NCBI::CUnionBuffer< TIupacna >   CSeq_data_Base::m_Iupacna
 
   NCBI_NS_NCBI::CUnionBuffer< TIupacaa >   CSeq_data_Base::m_Iupacaa
 
   NCBI_NS_NCBI::CUnionBuffer< TNcbi2na >   CSeq_data_Base::m_Ncbi2na
 
   NCBI_NS_NCBI::CUnionBuffer< TNcbi4na >   CSeq_data_Base::m_Ncbi4na
 
   NCBI_NS_NCBI::CUnionBuffer< TNcbi8na >   CSeq_data_Base::m_Ncbi8na
 
   NCBI_NS_NCBI::CUnionBuffer< TNcbipna >   CSeq_data_Base::m_Ncbipna
 
   NCBI_NS_NCBI::CUnionBuffer< TNcbi8aa >   CSeq_data_Base::m_Ncbi8aa
 
   NCBI_NS_NCBI::CUnionBuffer< TNcbieaa >   CSeq_data_Base::m_Ncbieaa
 
   NCBI_NS_NCBI::CUnionBuffer< TNcbipaa >   CSeq_data_Base::m_Ncbipaa
 
   NCBI_NS_NCBI::CUnionBuffer< TNcbistdaa >   CSeq_data_Base::m_Ncbistdaa
 
   NCBI_NS_NCBI::CSerialObject *   CSeq_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

*** Various internal sequence representations ************ * all are controlled, fixed length forms sequence representations

CSeq_data_Base

Definition at line 88 of file Seq_data_.hpp.


The documentation for this class was generated from the following files:
Modified on Mon Jul 22 05:03:39 2024 by modify_doxy.py rev. 669887