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

Represents ASN.1 type Blast4-get-sequences-request defined in file blast.asn

Search Toolkit Book for CBlast4_get_sequences_request_Base

Fetch sequence data from a BLAST database. More...

#include <objects/blast/Blast4_get_sequenc_request_.hpp>

+ Inheritance diagram for CBlast4_get_sequences_request_Base:
+ Collaboration diagram for CBlast4_get_sequences_request_Base:

Public Types

enum class  E_memberIndex {
  e__allMandatory = 0 , e_database , e_seq_ids , e_skip_seq_data ,
  e_target_only
}
 
typedef CBlast4_database TDatabase
 
typedef list< CRef< CSeq_id > > TSeq_ids
 
typedef bool TSkip_seq_data
 
typedef bool TTarget_only
 
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

 CBlast4_get_sequences_request_Base (void)
 
virtual ~CBlast4_get_sequences_request_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetDatabase (void) const
 Name of the BLAST database from which to retrieve the sequence data Check if a value has been assigned to Database data member. More...
 
bool CanGetDatabase (void) const
 Check if it is safe to call GetDatabase method. More...
 
void ResetDatabase (void)
 Reset Database data member. More...
 
const TDatabaseGetDatabase (void) const
 Get the Database member data. More...
 
void SetDatabase (TDatabase &value)
 Assign a value to Database data member. More...
 
TDatabaseSetDatabase (void)
 Assign a value to Database data member. More...
 
bool IsSetSeq_ids (void) const
 Sequence identifiers for the sequence to get Check if a value has been assigned to Seq_ids data member. More...
 
bool CanGetSeq_ids (void) const
 Check if it is safe to call GetSeq_ids method. More...
 
void ResetSeq_ids (void)
 Reset Seq_ids data member. More...
 
const TSeq_idsGetSeq_ids (void) const
 Get the Seq_ids member data. More...
 
TSeq_idsSetSeq_ids (void)
 Assign a value to Seq_ids data member. More...
 
bool IsSetSkip_seq_data (void) const
 Determines whether the returned Bioseqs should contain the sequence data or not Check if a value has been assigned to Skip_seq_data data member. More...
 
bool CanGetSkip_seq_data (void) const
 Check if it is safe to call GetSkip_seq_data method. More...
 
void ResetSkip_seq_data (void)
 Reset Skip_seq_data data member. More...
 
void SetDefaultSkip_seq_data (void)
 Assign default value to Skip_seq_data data member. More...
 
TSkip_seq_data GetSkip_seq_data (void) const
 Get the Skip_seq_data member data. More...
 
void SetSkip_seq_data (TSkip_seq_data value)
 Assign a value to Skip_seq_data data member. More...
 
TSkip_seq_dataSetSkip_seq_data (void)
 Assign a value to Skip_seq_data data member. More...
 
bool IsSetTarget_only (void) const
 Determines whether or not the defline of the returned Bioseqs should contain only the requested seq id. More...
 
bool CanGetTarget_only (void) const
 Check if it is safe to call GetTarget_only method. More...
 
void ResetTarget_only (void)
 Reset Target_only data member. More...
 
TTarget_only GetTarget_only (void) const
 Get the Target_only member data. More...
 
void SetTarget_only (TTarget_only value)
 Assign a value to Target_only data member. More...
 
TTarget_onlySetTarget_only (void)
 Assign a value to Target_only 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

 CBlast4_get_sequences_request_Base (const CBlast4_get_sequences_request_Base &)
 
CBlast4_get_sequences_request_Baseoperator= (const CBlast4_get_sequences_request_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
CRef< TDatabasem_Database
 
list< CRef< CSeq_id > > m_Seq_ids
 
bool m_Skip_seq_data
 
bool m_Target_only
 

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

Fetch sequence data from a BLAST database.

CBlast4_get_sequences_request_Base

Definition at line 78 of file Blast4_get_sequenc_request_.hpp.


The documentation for this class was generated from the following files:
Modified on Sat Apr 20 12:21:38 2024 by modify_doxy.py rev. 669887