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 Blast4-value defined in file blast.asn

Search Toolkit Book for CBlast4_value_Base

CBlast4_value_Base –. More...

#include <objects/blast/Blast4_value_.hpp>

+ Inheritance diagram for CBlast4_value_Base:
+ Collaboration diagram for CBlast4_value_Base:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_Big_integer , e_Bioseq , e_Boolean ,
  e_Cutoff , e_Integer , e_Matrix , e_Real ,
  e_Seq_align , e_Seq_id , e_Seq_loc , e_Strand_type ,
  e_String , e_Big_integer_list , e_Bioseq_list , e_Boolean_list ,
  e_Cutoff_list , e_Integer_list , e_Matrix_list , e_Real_list ,
  e_Seq_align_list , e_Seq_id_list , e_Seq_loc_list , e_Strand_type_list ,
  e_String_list , e_Bioseq_set , e_Seq_align_set , e_Query_mask
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 28 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef Int8 TBig_integer
 
typedef CBioseq TBioseq
 
typedef bool TBoolean
 
typedef CBlast4_cutoff TCutoff
 
typedef int TInteger
 
typedef CPssmWithParameters TMatrix
 
typedef double TReal
 
typedef CSeq_align TSeq_align
 
typedef CSeq_id TSeq_id
 
typedef CSeq_loc TSeq_loc
 
typedef EBlast4_strand_type TStrand_type
 
typedef string TString
 
typedef list< Int8TBig_integer_list
 
typedef list< CRef< CBioseq > > TBioseq_list
 
typedef list< boolTBoolean_list
 
typedef list< CRef< CBlast4_cutoff > > TCutoff_list
 
typedef list< intTInteger_list
 
typedef list< CRef< CPssmWithParameters > > TMatrix_list
 
typedef list< double > TReal_list
 
typedef list< CRef< CSeq_align > > TSeq_align_list
 
typedef list< CRef< CSeq_id > > TSeq_id_list
 
typedef list< CRef< CSeq_loc > > TSeq_loc_list
 
typedef list< EBlast4_strand_typeTStrand_type_list
 
typedef list< stringTString_list
 
typedef CBioseq_set TBioseq_set
 
typedef CSeq_align_set TSeq_align_set
 
typedef CBlast4_mask TQuery_mask
 
- 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

 CBlast4_value_Base (void)
 
virtual ~CBlast4_value_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 IsBig_integer (void) const
 Check if variant Big_integer is selected. More...
 
TBig_integer GetBig_integer (void) const
 Get the variant data. More...
 
TBig_integerSetBig_integer (void)
 Select the variant. More...
 
void SetBig_integer (TBig_integer value)
 Select the variant and set its data. More...
 
bool IsBioseq (void) const
 Check if variant Bioseq is selected. More...
 
const TBioseqGetBioseq (void) const
 Get the variant data. More...
 
TBioseqSetBioseq (void)
 Select the variant. More...
 
void SetBioseq (TBioseq &value)
 Select the variant and set its data. More...
 
bool IsBoolean (void) const
 Check if variant Boolean is selected. More...
 
TBoolean GetBoolean (void) const
 Get the variant data. More...
 
TBooleanSetBoolean (void)
 Select the variant. More...
 
void SetBoolean (TBoolean value)
 Select the variant and set its data. More...
 
bool IsCutoff (void) const
 Check if variant Cutoff is selected. More...
 
const TCutoffGetCutoff (void) const
 Get the variant data. More...
 
TCutoffSetCutoff (void)
 Select the variant. More...
 
void SetCutoff (TCutoff &value)
 Select the variant and set its data. More...
 
bool IsInteger (void) const
 Check if variant Integer is selected. More...
 
TInteger GetInteger (void) const
 Get the variant data. More...
 
TIntegerSetInteger (void)
 Select the variant. More...
 
void SetInteger (TInteger value)
 Select the variant and set its data. More...
 
bool IsMatrix (void) const
 Check if variant Matrix is selected. More...
 
const TMatrixGetMatrix (void) const
 Get the variant data. More...
 
TMatrixSetMatrix (void)
 Select the variant. More...
 
void SetMatrix (TMatrix &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 IsSeq_align (void) const
 Check if variant Seq_align is selected. More...
 
const TSeq_alignGetSeq_align (void) const
 Get the variant data. More...
 
TSeq_alignSetSeq_align (void)
 Select the variant. More...
 
void SetSeq_align (TSeq_align &value)
 Select the variant and set its data. More...
 
bool IsSeq_id (void) const
 Check if variant Seq_id is selected. More...
 
const TSeq_idGetSeq_id (void) const
 Get the variant data. More...
 
TSeq_idSetSeq_id (void)
 Select the variant. More...
 
void SetSeq_id (TSeq_id &value)
 Select the variant and set its data. More...
 
bool IsSeq_loc (void) const
 Check if variant Seq_loc is selected. More...
 
const TSeq_locGetSeq_loc (void) const
 Get the variant data. More...
 
TSeq_locSetSeq_loc (void)
 Select the variant. More...
 
void SetSeq_loc (TSeq_loc &value)
 Select the variant and set its data. More...
 
bool IsStrand_type (void) const
 Check if variant Strand_type is selected. More...
 
TStrand_type GetStrand_type (void) const
 Get the variant data. More...
 
TStrand_typeSetStrand_type (void)
 Select the variant. More...
 
void SetStrand_type (TStrand_type 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 IsBig_integer_list (void) const
 Check if variant Big_integer_list is selected. More...
 
const TBig_integer_listGetBig_integer_list (void) const
 Get the variant data. More...
 
TBig_integer_listSetBig_integer_list (void)
 Select the variant. More...
 
bool IsBioseq_list (void) const
 Check if variant Bioseq_list is selected. More...
 
const TBioseq_listGetBioseq_list (void) const
 Get the variant data. More...
 
TBioseq_listSetBioseq_list (void)
 Select the variant. More...
 
bool IsBoolean_list (void) const
 Check if variant Boolean_list is selected. More...
 
const TBoolean_listGetBoolean_list (void) const
 Get the variant data. More...
 
TBoolean_listSetBoolean_list (void)
 Select the variant. More...
 
bool IsCutoff_list (void) const
 Check if variant Cutoff_list is selected. More...
 
const TCutoff_listGetCutoff_list (void) const
 Get the variant data. More...
 
TCutoff_listSetCutoff_list (void)
 Select the variant. More...
 
bool IsInteger_list (void) const
 Check if variant Integer_list is selected. More...
 
const TInteger_listGetInteger_list (void) const
 Get the variant data. More...
 
TInteger_listSetInteger_list (void)
 Select the variant. More...
 
bool IsMatrix_list (void) const
 Check if variant Matrix_list is selected. More...
 
const TMatrix_listGetMatrix_list (void) const
 Get the variant data. More...
 
TMatrix_listSetMatrix_list (void)
 Select the variant. More...
 
bool IsReal_list (void) const
 Check if variant Real_list is selected. More...
 
const TReal_listGetReal_list (void) const
 Get the variant data. More...
 
TReal_listSetReal_list (void)
 Select the variant. More...
 
bool IsSeq_align_list (void) const
 Check if variant Seq_align_list is selected. More...
 
const TSeq_align_listGetSeq_align_list (void) const
 Get the variant data. More...
 
TSeq_align_listSetSeq_align_list (void)
 Select the variant. More...
 
bool IsSeq_id_list (void) const
 Check if variant Seq_id_list is selected. More...
 
const TSeq_id_listGetSeq_id_list (void) const
 Get the variant data. More...
 
TSeq_id_listSetSeq_id_list (void)
 Select the variant. More...
 
bool IsSeq_loc_list (void) const
 Check if variant Seq_loc_list is selected. More...
 
const TSeq_loc_listGetSeq_loc_list (void) const
 Get the variant data. More...
 
TSeq_loc_listSetSeq_loc_list (void)
 Select the variant. More...
 
bool IsStrand_type_list (void) const
 Check if variant Strand_type_list is selected. More...
 
const TStrand_type_listGetStrand_type_list (void) const
 Get the variant data. More...
 
TStrand_type_listSetStrand_type_list (void)
 Select the variant. More...
 
bool IsString_list (void) const
 Check if variant String_list is selected. More...
 
const TString_listGetString_list (void) const
 Get the variant data. More...
 
TString_listSetString_list (void)
 Select the variant. More...
 
bool IsBioseq_set (void) const
 Check if variant Bioseq_set is selected. More...
 
const TBioseq_setGetBioseq_set (void) const
 Get the variant data. More...
 
TBioseq_setSetBioseq_set (void)
 Select the variant. More...
 
void SetBioseq_set (TBioseq_set &value)
 Select the variant and set its data. More...
 
bool IsSeq_align_set (void) const
 Check if variant Seq_align_set is selected. More...
 
const TSeq_align_setGetSeq_align_set (void) const
 Get the variant data. More...
 
TSeq_align_setSetSeq_align_set (void)
 Select the variant. More...
 
void SetSeq_align_set (TSeq_align_set &value)
 Select the variant and set its data. More...
 
bool IsQuery_mask (void) const
 Check if variant Query_mask is selected. More...
 
const TQuery_maskGetQuery_mask (void) const
 Get the variant data. More...
 
TQuery_maskSetQuery_mask (void)
 Select the variant. More...
 
void SetQuery_mask (TQuery_mask &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

 CBlast4_value_Base (const CBlast4_value_Base &)
 
CBlast4_value_Baseoperator= (const CBlast4_value_Base &)
 
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
union {
   TBig_integer   CBlast4_value_Base::m_Big_integer
 
   TBoolean   CBlast4_value_Base::m_Boolean
 
   TInteger   CBlast4_value_Base::m_Integer
 
   TReal   CBlast4_value_Base::m_Real
 
   TStrand_type   CBlast4_value_Base::m_Strand_type
 
   NCBI_NS_NCBI::CUnionBuffer< TBig_integer_list >   CBlast4_value_Base::m_Big_integer_list
 
   NCBI_NS_NCBI::CUnionBuffer< TBioseq_list >   CBlast4_value_Base::m_Bioseq_list
 
   NCBI_NS_NCBI::CUnionBuffer< TBoolean_list >   CBlast4_value_Base::m_Boolean_list
 
   NCBI_NS_NCBI::CUnionBuffer< TCutoff_list >   CBlast4_value_Base::m_Cutoff_list
 
   NCBI_NS_NCBI::CUnionBuffer< TInteger_list >   CBlast4_value_Base::m_Integer_list
 
   NCBI_NS_NCBI::CUnionBuffer< TMatrix_list >   CBlast4_value_Base::m_Matrix_list
 
   NCBI_NS_NCBI::CUnionBuffer< TReal_list >   CBlast4_value_Base::m_Real_list
 
   NCBI_NS_NCBI::CUnionBuffer< TSeq_align_list >   CBlast4_value_Base::m_Seq_align_list
 
   NCBI_NS_NCBI::CUnionBuffer< TSeq_id_list >   CBlast4_value_Base::m_Seq_id_list
 
   NCBI_NS_NCBI::CUnionBuffer< TSeq_loc_list >   CBlast4_value_Base::m_Seq_loc_list
 
   NCBI_NS_NCBI::CUnionBuffer< TStrand_type_list >   CBlast4_value_Base::m_Strand_type_list
 
   NCBI_NS_NCBI::CUnionBuffer< TString_list >   CBlast4_value_Base::m_String_list
 
   NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string >   CBlast4_value_Base::m_string
 
   NCBI_NS_NCBI::CSerialObject *   CBlast4_value_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

CBlast4_value_Base –.

Definition at line 86 of file Blast4_value_.hpp.


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