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

Represents ASN.1 type Blast-db-mask-info defined in file blastdb.asn

Search Toolkit Book for CBlast_db_mask_info_Base

Defines the masking information for a set of sequences. More...

#include <objects/blastdb/Blast_db_mask_info_.hpp>

+ Inheritance diagram for CBlast_db_mask_info_Base:
+ Collaboration diagram for CBlast_db_mask_info_Base:

Public Types

enum class  E_memberIndex {
  e__allMandatory = 0 , e_algo_id , e_algo_program , e_algo_options ,
  e_masks
}
 
typedef int TAlgo_id
 
typedef int TAlgo_program
 
typedef string TAlgo_options
 
typedef CBlast_mask_list TMasks
 
typedef Tparent::CMemberIndex< E_memberIndex, 5 > 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

 CBlast_db_mask_info_Base (void)
 
virtual ~CBlast_db_mask_info_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetAlgo_id (void) const
 Check if a value has been assigned to Algo_id data member. More...
 
bool CanGetAlgo_id (void) const
 Check if it is safe to call GetAlgo_id method. More...
 
void ResetAlgo_id (void)
 Reset Algo_id data member. More...
 
TAlgo_id GetAlgo_id (void) const
 Get the Algo_id member data. More...
 
void SetAlgo_id (TAlgo_id value)
 Assign a value to Algo_id data member. More...
 
TAlgo_idSetAlgo_id (void)
 Assign a value to Algo_id data member. More...
 
bool IsSetAlgo_program (void) const
 Check if a value has been assigned to Algo_program data member. More...
 
bool CanGetAlgo_program (void) const
 Check if it is safe to call GetAlgo_program method. More...
 
void ResetAlgo_program (void)
 Reset Algo_program data member. More...
 
TAlgo_program GetAlgo_program (void) const
 Get the Algo_program member data. More...
 
void SetAlgo_program (TAlgo_program value)
 Assign a value to Algo_program data member. More...
 
TAlgo_programSetAlgo_program (void)
 Assign a value to Algo_program data member. More...
 
bool IsSetAlgo_options (void) const
 Check if a value has been assigned to Algo_options data member. More...
 
bool CanGetAlgo_options (void) const
 Check if it is safe to call GetAlgo_options method. More...
 
void ResetAlgo_options (void)
 Reset Algo_options data member. More...
 
const TAlgo_optionsGetAlgo_options (void) const
 Get the Algo_options member data. More...
 
void SetAlgo_options (const TAlgo_options &value)
 Assign a value to Algo_options data member. More...
 
void SetAlgo_options (TAlgo_options &&value)
 
TAlgo_optionsSetAlgo_options (void)
 Assign a value to Algo_options data member. More...
 
bool IsSetMasks (void) const
 This object was originally created to allow pagination of the sequence masks, but this feature was discontinued in 01/21/2010 Check if a value has been assigned to Masks data member. More...
 
bool CanGetMasks (void) const
 Check if it is safe to call GetMasks method. More...
 
void ResetMasks (void)
 Reset Masks data member. More...
 
const TMasksGetMasks (void) const
 Get the Masks member data. More...
 
void SetMasks (TMasks &value)
 Assign a value to Masks data member. More...
 
TMasksSetMasks (void)
 Assign a value to Masks 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
 

Private Types

typedef CSerialObject Tparent
 

Private Member Functions

 CBlast_db_mask_info_Base (const CBlast_db_mask_info_Base &)
 
CBlast_db_mask_info_Baseoperator= (const CBlast_db_mask_info_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
int m_Algo_id
 
int m_Algo_program
 
string m_Algo_options
 
CRef< TMasksm_Masks
 

Additional Inherited Members

- 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)
 
- 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

Defines the masking information for a set of sequences.

CBlast_db_mask_info_Base

Definition at line 78 of file Blast_db_mask_info_.hpp.


The documentation for this class was generated from the following files:
Modified on Tue May 21 11:02:07 2024 by modify_doxy.py rev. 669887