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-id defined in file seqloc.asn

Search Toolkit Book for CSeq_id_Base

*** Sequence identifiers ******************************** * More...

#include <objects/seqloc/Seq_id_.hpp>

+ Inheritance diagram for CSeq_id_Base:
+ Collaboration diagram for CSeq_id_Base:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_Local , e_Gibbsq , e_Gibbmt ,
  e_Giim , e_Genbank , e_Embl , e_Pir ,
  e_Swissprot , e_Patent , e_Other , e_General ,
  e_Gi , e_Ddbj , e_Prf , e_Pdb ,
  e_Tpg , e_Tpe , e_Tpd , e_Gpipe ,
  e_Named_annot_track
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 21 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef CObject_id TLocal
 
typedef int TGibbsq
 
typedef int TGibbmt
 
typedef CGiimport_id TGiim
 
typedef CTextseq_id TGenbank
 
typedef CTextseq_id TEmbl
 
typedef CTextseq_id TPir
 
typedef CTextseq_id TSwissprot
 
typedef CPatent_seq_id TPatent
 
typedef CTextseq_id TOther
 
typedef CDbtag TGeneral
 
typedef NCBI_NS_NCBI::TGi TGi
 
typedef CTextseq_id TDdbj
 
typedef CTextseq_id TPrf
 
typedef CPDB_seq_id TPdb
 
typedef CTextseq_id TTpg
 
typedef CTextseq_id TTpe
 
typedef CTextseq_id TTpd
 
typedef CTextseq_id TGpipe
 
typedef CTextseq_id TNamed_annot_track
 
- 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_id_Base (void)
 
virtual ~CSeq_id_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 IsLocal (void) const
 Check if variant Local is selected. More...
 
const TLocalGetLocal (void) const
 Get the variant data. More...
 
TLocalSetLocal (void)
 Select the variant. More...
 
void SetLocal (TLocal &value)
 Select the variant and set its data. More...
 
bool IsGibbsq (void) const
 Check if variant Gibbsq is selected. More...
 
TGibbsq GetGibbsq (void) const
 Get the variant data. More...
 
TGibbsqSetGibbsq (void)
 Select the variant. More...
 
void SetGibbsq (TGibbsq value)
 Select the variant and set its data. More...
 
bool IsGibbmt (void) const
 Check if variant Gibbmt is selected. More...
 
TGibbmt GetGibbmt (void) const
 Get the variant data. More...
 
TGibbmtSetGibbmt (void)
 Select the variant. More...
 
void SetGibbmt (TGibbmt value)
 Select the variant and set its data. More...
 
bool IsGiim (void) const
 Check if variant Giim is selected. More...
 
const TGiimGetGiim (void) const
 Get the variant data. More...
 
TGiimSetGiim (void)
 Select the variant. More...
 
void SetGiim (TGiim &value)
 Select the variant and set its data. More...
 
bool IsGenbank (void) const
 Check if variant Genbank is selected. More...
 
const TGenbankGetGenbank (void) const
 Get the variant data. More...
 
TGenbankSetGenbank (void)
 Select the variant. More...
 
void SetGenbank (TGenbank &value)
 Select the variant and set its data. More...
 
bool IsEmbl (void) const
 Check if variant Embl is selected. More...
 
const TEmblGetEmbl (void) const
 Get the variant data. More...
 
TEmblSetEmbl (void)
 Select the variant. More...
 
void SetEmbl (TEmbl &value)
 Select the variant and set its data. More...
 
bool IsPir (void) const
 Check if variant Pir is selected. More...
 
const TPirGetPir (void) const
 Get the variant data. More...
 
TPirSetPir (void)
 Select the variant. More...
 
void SetPir (TPir &value)
 Select the variant and set its data. More...
 
bool IsSwissprot (void) const
 Check if variant Swissprot is selected. More...
 
const TSwissprotGetSwissprot (void) const
 Get the variant data. More...
 
TSwissprotSetSwissprot (void)
 Select the variant. More...
 
void SetSwissprot (TSwissprot &value)
 Select the variant and set its data. More...
 
bool IsPatent (void) const
 Check if variant Patent is selected. More...
 
const TPatentGetPatent (void) const
 Get the variant data. More...
 
TPatentSetPatent (void)
 Select the variant. More...
 
void SetPatent (TPatent &value)
 Select the variant and set its data. More...
 
bool IsOther (void) const
 Check if variant Other is selected. More...
 
const TOtherGetOther (void) const
 Get the variant data. More...
 
TOtherSetOther (void)
 Select the variant. More...
 
void SetOther (TOther &value)
 Select the variant and set its data. More...
 
bool IsGeneral (void) const
 Check if variant General is selected. More...
 
const TGeneralGetGeneral (void) const
 Get the variant data. More...
 
TGeneralSetGeneral (void)
 Select the variant. More...
 
void SetGeneral (TGeneral &value)
 Select the variant and set its data. More...
 
bool IsGi (void) const
 Check if variant Gi is selected. More...
 
TGi GetGi (void) const
 Get the variant data. More...
 
TGiSetGi (void)
 Select the variant. More...
 
void SetGi (TGi value)
 Select the variant and set its data. More...
 
bool IsDdbj (void) const
 Check if variant Ddbj is selected. More...
 
const TDdbjGetDdbj (void) const
 Get the variant data. More...
 
TDdbjSetDdbj (void)
 Select the variant. More...
 
void SetDdbj (TDdbj &value)
 Select the variant and set its data. More...
 
bool IsPrf (void) const
 Check if variant Prf is selected. More...
 
const TPrfGetPrf (void) const
 Get the variant data. More...
 
TPrfSetPrf (void)
 Select the variant. More...
 
void SetPrf (TPrf &value)
 Select the variant and set its data. More...
 
bool IsPdb (void) const
 Check if variant Pdb is selected. More...
 
const TPdbGetPdb (void) const
 Get the variant data. More...
 
TPdbSetPdb (void)
 Select the variant. More...
 
void SetPdb (TPdb &value)
 Select the variant and set its data. More...
 
bool IsTpg (void) const
 Check if variant Tpg is selected. More...
 
const TTpgGetTpg (void) const
 Get the variant data. More...
 
TTpgSetTpg (void)
 Select the variant. More...
 
void SetTpg (TTpg &value)
 Select the variant and set its data. More...
 
bool IsTpe (void) const
 Check if variant Tpe is selected. More...
 
const TTpeGetTpe (void) const
 Get the variant data. More...
 
TTpeSetTpe (void)
 Select the variant. More...
 
void SetTpe (TTpe &value)
 Select the variant and set its data. More...
 
bool IsTpd (void) const
 Check if variant Tpd is selected. More...
 
const TTpdGetTpd (void) const
 Get the variant data. More...
 
TTpdSetTpd (void)
 Select the variant. More...
 
void SetTpd (TTpd &value)
 Select the variant and set its data. More...
 
bool IsGpipe (void) const
 Check if variant Gpipe is selected. More...
 
const TGpipeGetGpipe (void) const
 Get the variant data. More...
 
TGpipeSetGpipe (void)
 Select the variant. More...
 
void SetGpipe (TGpipe &value)
 Select the variant and set its data. More...
 
bool IsNamed_annot_track (void) const
 Check if variant Named_annot_track is selected. More...
 
const TNamed_annot_trackGetNamed_annot_track (void) const
 Get the variant data. More...
 
TNamed_annot_trackSetNamed_annot_track (void)
 Select the variant. More...
 
void SetNamed_annot_track (TNamed_annot_track &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_id_Base (const CSeq_id_Base &)
 
CSeq_id_Baseoperator= (const CSeq_id_Base &)
 
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
union {
   TGibbsq   CSeq_id_Base::m_Gibbsq
 
   TGibbmt   CSeq_id_Base::m_Gibbmt
 
   ncbi::TIntId   CSeq_id_Base::m_Gi
 
   NCBI_NS_NCBI::CSerialObject *   CSeq_id_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

*** Sequence identifiers ******************************** *

CSeq_id_Base

Definition at line 79 of file Seq_id_.hpp.


The documentation for this class was generated from the following files:
Modified on Sat Jul 13 13:40:07 2024 by modify_doxy.py rev. 669887