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

Represents ASN.1 type BlastOutput defined in file blastxml.asn

Search Toolkit Book for CBlastOutput

CBlastOutput –. More...

#include <objects/blastxml/BlastOutput.hpp>

+ Inheritance diagram for CBlastOutput:
+ Collaboration diagram for CBlastOutput:

Public Member Functions

 CBlastOutput (void)
 
 ~CBlastOutput (void)
 
- Public Member Functions inherited from CBlastOutput_Base
 CBlastOutput_Base (void)
 
virtual ~CBlastOutput_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetProgram (void) const
 BLAST program: blastp, tblastx etc. More...
 
bool CanGetProgram (void) const
 Check if it is safe to call GetProgram method. More...
 
void ResetProgram (void)
 Reset Program data member. More...
 
const TProgramGetProgram (void) const
 Get the Program member data. More...
 
void SetProgram (const TProgram &value)
 Assign a value to Program data member. More...
 
void SetProgram (TProgram &&value)
 
TProgramSetProgram (void)
 Assign a value to Program data member. More...
 
bool IsSetVersion (void) const
 Program version Check if a value has been assigned to Version data member. More...
 
bool CanGetVersion (void) const
 Check if it is safe to call GetVersion method. More...
 
void ResetVersion (void)
 Reset Version data member. More...
 
const TVersionGetVersion (void) const
 Get the Version member data. More...
 
void SetVersion (const TVersion &value)
 Assign a value to Version data member. More...
 
void SetVersion (TVersion &&value)
 
TVersionSetVersion (void)
 Assign a value to Version data member. More...
 
bool IsSetReference (void) const
 Steven, David, Tom and others Check if a value has been assigned to Reference data member. More...
 
bool CanGetReference (void) const
 Check if it is safe to call GetReference method. More...
 
void ResetReference (void)
 Reset Reference data member. More...
 
const TReferenceGetReference (void) const
 Get the Reference member data. More...
 
void SetReference (const TReference &value)
 Assign a value to Reference data member. More...
 
void SetReference (TReference &&value)
 
TReferenceSetReference (void)
 Assign a value to Reference data member. More...
 
bool IsSetDb (void) const
 BLAST Database name Check if a value has been assigned to Db data member. More...
 
bool CanGetDb (void) const
 Check if it is safe to call GetDb method. More...
 
void ResetDb (void)
 Reset Db data member. More...
 
const TDbGetDb (void) const
 Get the Db member data. More...
 
void SetDb (const TDb &value)
 Assign a value to Db data member. More...
 
void SetDb (TDb &&value)
 
TDbSetDb (void)
 Assign a value to Db data member. More...
 
bool IsSetQuery_ID (void) const
 SeqId of query Check if a value has been assigned to Query_ID data member. More...
 
bool CanGetQuery_ID (void) const
 Check if it is safe to call GetQuery_ID method. More...
 
void ResetQuery_ID (void)
 Reset Query_ID data member. More...
 
const TQuery_IDGetQuery_ID (void) const
 Get the Query_ID member data. More...
 
void SetQuery_ID (const TQuery_ID &value)
 Assign a value to Query_ID data member. More...
 
void SetQuery_ID (TQuery_ID &&value)
 
TQuery_IDSetQuery_ID (void)
 Assign a value to Query_ID data member. More...
 
bool IsSetQuery_def (void) const
 Definition line of query Check if a value has been assigned to Query_def data member. More...
 
bool CanGetQuery_def (void) const
 Check if it is safe to call GetQuery_def method. More...
 
void ResetQuery_def (void)
 Reset Query_def data member. More...
 
const TQuery_defGetQuery_def (void) const
 Get the Query_def member data. More...
 
void SetQuery_def (const TQuery_def &value)
 Assign a value to Query_def data member. More...
 
void SetQuery_def (TQuery_def &&value)
 
TQuery_defSetQuery_def (void)
 Assign a value to Query_def data member. More...
 
bool IsSetQuery_len (void) const
 length of query sequence Check if a value has been assigned to Query_len data member. More...
 
bool CanGetQuery_len (void) const
 Check if it is safe to call GetQuery_len method. More...
 
void ResetQuery_len (void)
 Reset Query_len data member. More...
 
TQuery_len GetQuery_len (void) const
 Get the Query_len member data. More...
 
void SetQuery_len (TQuery_len value)
 Assign a value to Query_len data member. More...
 
TQuery_lenSetQuery_len (void)
 Assign a value to Query_len data member. More...
 
bool IsSetQuery_seq (void) const
 query sequence itself Check if a value has been assigned to Query_seq data member. More...
 
bool CanGetQuery_seq (void) const
 Check if it is safe to call GetQuery_seq method. More...
 
void ResetQuery_seq (void)
 Reset Query_seq data member. More...
 
const TQuery_seqGetQuery_seq (void) const
 Get the Query_seq member data. More...
 
void SetQuery_seq (const TQuery_seq &value)
 Assign a value to Query_seq data member. More...
 
void SetQuery_seq (TQuery_seq &&value)
 
TQuery_seqSetQuery_seq (void)
 Assign a value to Query_seq data member. More...
 
bool IsSetParam (void) const
 search parameters Check if a value has been assigned to Param data member. More...
 
bool CanGetParam (void) const
 Check if it is safe to call GetParam method. More...
 
void ResetParam (void)
 Reset Param data member. More...
 
const TParamGetParam (void) const
 Get the Param member data. More...
 
void SetParam (TParam &value)
 Assign a value to Param data member. More...
 
TParamSetParam (void)
 Assign a value to Param data member. More...
 
bool IsSetIterations (void) const
 Check if a value has been assigned to Iterations data member. More...
 
bool CanGetIterations (void) const
 Check if it is safe to call GetIterations method. More...
 
void ResetIterations (void)
 Reset Iterations data member. More...
 
const TIterationsGetIterations (void) const
 Get the Iterations member data. More...
 
TIterationsSetIterations (void)
 Assign a value to Iterations data member. More...
 
bool IsSetMbstat (void) const
 Mega BLAST search statistics Check if a value has been assigned to Mbstat data member. More...
 
bool CanGetMbstat (void) const
 Check if it is safe to call GetMbstat method. More...
 
void ResetMbstat (void)
 Reset Mbstat data member. More...
 
const TMbstatGetMbstat (void) const
 Get the Mbstat member data. More...
 
void SetMbstat (TMbstat &value)
 Assign a value to Mbstat data member. More...
 
TMbstatSetMbstat (void)
 Assign a value to Mbstat 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 CBlastOutput_Base Tparent
 

Private Member Functions

 CBlastOutput (const CBlastOutput &value)
 
CBlastOutputoperator= (const CBlastOutput &value)
 

Additional Inherited Members

- Public Types inherited from CBlastOutput_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_program , e_version , e_reference ,
  e_db , e_query_ID , e_query_def , e_query_len ,
  e_query_seq , e_param , e_iterations , e_mbstat
}
 
typedef string TProgram
 
typedef string TVersion
 
typedef string TReference
 
typedef string TDb
 
typedef string TQuery_ID
 
typedef string TQuery_def
 
typedef int TQuery_len
 
typedef string TQuery_seq
 
typedef CParameters TParam
 
typedef list< CRef< CIteration > > TIterations
 
typedef CStatistics TMbstat
 
typedef Tparent::CMemberIndex< E_memberIndex, 12 > 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...
 
- 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

CBlastOutput –.

Definition at line 65 of file BlastOutput.hpp.


The documentation for this class was generated from the following files:
Modified on Thu Mar 28 17:05:22 2024 by modify_doxy.py rev. 669887