NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members

Represents ASN.1 type ID2-Get-Blob-Details defined in file id2.asn

Search Toolkit Book for CID2_Get_Blob_Details_Base

The following structure describes what parts of blob are required immediately after ID2-Request-Get-Blob-Info in case blob is split. More...

#include <objects/id2/ID2_Get_Blob_Details_.hpp>

+ Inheritance diagram for CID2_Get_Blob_Details_Base:
+ Collaboration diagram for CID2_Get_Blob_Details_Base:

Public Types

enum  ESequence_level { eSequence_level_none = 0 , eSequence_level_seq_map = 1 , eSequence_level_seq_data = 2 }
 level of sequence data to load More...
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_location , e_seq_class_level , e_descr_level ,
  e_descr_type_mask , e_annot_type_mask , e_feat_type_mask , e_sequence_level
}
 
typedef CSeq_loc TLocation
 
typedef int TSeq_class_level
 
typedef int TDescr_level
 
typedef int TDescr_type_mask
 
typedef int TAnnot_type_mask
 
typedef int TFeat_type_mask
 
typedef ESequence_level TSequence_level
 
typedef Tparent::CMemberIndex< E_memberIndex, 8 > TmemberIndex
 
- 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

 CID2_Get_Blob_Details_Base (void)
 
virtual ~CID2_Get_Blob_Details_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetLocation (void) const
 reference location for details - can be only part of sequence Check if a value has been assigned to Location data member. More...
 
bool CanGetLocation (void) const
 Check if it is safe to call GetLocation method. More...
 
void ResetLocation (void)
 Reset Location data member. More...
 
const TLocationGetLocation (void) const
 Get the Location member data. More...
 
void SetLocation (TLocation &value)
 Assign a value to Location data member. More...
 
TLocationSetLocation (void)
 Assign a value to Location data member. More...
 
bool IsSetSeq_class_level (void) const
 Seq-entry level for all data except descriptors (sequnence, annots) Check if a value has been assigned to Seq_class_level data member. More...
 
bool CanGetSeq_class_level (void) const
 Check if it is safe to call GetSeq_class_level method. More...
 
void ResetSeq_class_level (void)
 Reset Seq_class_level data member. More...
 
void SetDefaultSeq_class_level (void)
 Assign default value to Seq_class_level data member. More...
 
TSeq_class_level GetSeq_class_level (void) const
 Get the Seq_class_level member data. More...
 
void SetSeq_class_level (TSeq_class_level value)
 Assign a value to Seq_class_level data member. More...
 
TSeq_class_levelSetSeq_class_level (void)
 Assign a value to Seq_class_level data member. More...
 
bool IsSetDescr_level (void) const
 Seq-entry level for descriptors Check if a value has been assigned to Descr_level data member. More...
 
bool CanGetDescr_level (void) const
 Check if it is safe to call GetDescr_level method. More...
 
void ResetDescr_level (void)
 Reset Descr_level data member. More...
 
void SetDefaultDescr_level (void)
 Assign default value to Descr_level data member. More...
 
TDescr_level GetDescr_level (void) const
 Get the Descr_level member data. More...
 
void SetDescr_level (TDescr_level value)
 Assign a value to Descr_level data member. More...
 
TDescr_levelSetDescr_level (void)
 Assign a value to Descr_level data member. More...
 
bool IsSetDescr_type_mask (void) const
 mask of descriptor types - see Seqdesc for variants' values Check if a value has been assigned to Descr_type_mask data member. More...
 
bool CanGetDescr_type_mask (void) const
 Check if it is safe to call GetDescr_type_mask method. More...
 
void ResetDescr_type_mask (void)
 Reset Descr_type_mask data member. More...
 
void SetDefaultDescr_type_mask (void)
 Assign default value to Descr_type_mask data member. More...
 
TDescr_type_mask GetDescr_type_mask (void) const
 Get the Descr_type_mask member data. More...
 
void SetDescr_type_mask (TDescr_type_mask value)
 Assign a value to Descr_type_mask data member. More...
 
TDescr_type_maskSetDescr_type_mask (void)
 Assign a value to Descr_type_mask data member. More...
 
bool IsSetAnnot_type_mask (void) const
 mask of annotation types - see Seq-annot.data for values Check if a value has been assigned to Annot_type_mask data member. More...
 
bool CanGetAnnot_type_mask (void) const
 Check if it is safe to call GetAnnot_type_mask method. More...
 
void ResetAnnot_type_mask (void)
 Reset Annot_type_mask data member. More...
 
void SetDefaultAnnot_type_mask (void)
 Assign default value to Annot_type_mask data member. More...
 
TAnnot_type_mask GetAnnot_type_mask (void) const
 Get the Annot_type_mask member data. More...
 
void SetAnnot_type_mask (TAnnot_type_mask value)
 Assign a value to Annot_type_mask data member. More...
 
TAnnot_type_maskSetAnnot_type_mask (void)
 Assign a value to Annot_type_mask data member. More...
 
bool IsSetFeat_type_mask (void) const
 mask of feature types - see SeqFeatData for values Check if a value has been assigned to Feat_type_mask data member. More...
 
bool CanGetFeat_type_mask (void) const
 Check if it is safe to call GetFeat_type_mask method. More...
 
void ResetFeat_type_mask (void)
 Reset Feat_type_mask data member. More...
 
void SetDefaultFeat_type_mask (void)
 Assign default value to Feat_type_mask data member. More...
 
TFeat_type_mask GetFeat_type_mask (void) const
 Get the Feat_type_mask member data. More...
 
void SetFeat_type_mask (TFeat_type_mask value)
 Assign a value to Feat_type_mask data member. More...
 
TFeat_type_maskSetFeat_type_mask (void)
 Assign a value to Feat_type_mask data member. More...
 
bool IsSetSequence_level (void) const
 Check if a value has been assigned to Sequence_level data member. More...
 
bool CanGetSequence_level (void) const
 Check if it is safe to call GetSequence_level method. More...
 
void ResetSequence_level (void)
 Reset Sequence_level data member. More...
 
void SetDefaultSequence_level (void)
 Assign default value to Sequence_level data member. More...
 
TSequence_level GetSequence_level (void) const
 Get the Sequence_level member data. More...
 
void SetSequence_level (TSequence_level value)
 Assign a value to Sequence_level data member. More...
 
TSequence_levelSetSequence_level (void)
 Assign a value to Sequence_level data member. More...
 
virtual void Reset (void)
 Reset the whole object. 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 const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ESequence_level (void)
 Access to ESequence_level's attributes (values, names) as defined in spec. 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

 CID2_Get_Blob_Details_Base (const CID2_Get_Blob_Details_Base &)
 
CID2_Get_Blob_Details_Baseoperator= (const CID2_Get_Blob_Details_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
CRef< TLocationm_Location
 
int m_Seq_class_level
 
int m_Descr_level
 
int m_Descr_type_mask
 
int m_Annot_type_mask
 
int m_Feat_type_mask
 
ESequence_level m_Sequence_level
 

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

The following structure describes what parts of blob are required immediately after ID2-Request-Get-Blob-Info in case blob is split.

Seq-entry level will have probably the same values as Entry-complexities.

CID2_Get_Blob_Details_Base

Definition at line 75 of file ID2_Get_Blob_Details_.hpp.


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