Search Toolkit Book for CIteration
#include <objects/blastxml/Iteration.hpp>
Inheritance diagram for CIteration:
Collaboration diagram for CIteration:
Public Member Functions | |
| CIteration (void) | |
| ~CIteration (void) | |
| CIteration (void) | |
| ~CIteration (void) | |
| Public Member Functions inherited from CIteration_Base | |
| CIteration_Base (void) | |
| virtual | ~CIteration_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetIter_num (void) const |
| iteration number Check if a value has been assigned to Iter_num data member. More... | |
| bool | CanGetIter_num (void) const |
| Check if it is safe to call GetIter_num method. More... | |
| void | ResetIter_num (void) |
| Reset Iter_num data member. More... | |
| TIter_num | GetIter_num (void) const |
| Get the Iter_num member data. More... | |
| void | SetIter_num (TIter_num value) |
| Assign a value to Iter_num data member. More... | |
| TIter_num & | SetIter_num (void) |
| Assign a value to Iter_num 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_ID & | GetQuery_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_ID & | SetQuery_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_def & | GetQuery_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_def & | SetQuery_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_len & | SetQuery_len (void) |
| Assign a value to Query_len data member. More... | |
| bool | IsSetHits (void) const |
| Hits one for every db sequence Check if a value has been assigned to Hits data member. More... | |
| bool | CanGetHits (void) const |
| Check if it is safe to call GetHits method. More... | |
| void | ResetHits (void) |
| Reset Hits data member. More... | |
| const THits & | GetHits (void) const |
| Get the Hits member data. More... | |
| THits & | SetHits (void) |
| Assign a value to Hits data member. More... | |
| bool | IsSetStat (void) const |
| search statistics Check if a value has been assigned to Stat data member. More... | |
| bool | CanGetStat (void) const |
| Check if it is safe to call GetStat method. More... | |
| void | ResetStat (void) |
| Reset Stat data member. More... | |
| const TStat & | GetStat (void) const |
| Get the Stat member data. More... | |
| void | SetStat (TStat &value) |
| Assign a value to Stat data member. More... | |
| TStat & | SetStat (void) |
| Assign a value to Stat data member. More... | |
| bool | IsSetMessage (void) const |
| Some (error?) information Check if a value has been assigned to Message data member. More... | |
| bool | CanGetMessage (void) const |
| Check if it is safe to call GetMessage method. More... | |
| void | ResetMessage (void) |
| Reset Message data member. More... | |
| const TMessage & | GetMessage (void) const |
| Get the Message member data. More... | |
| void | SetMessage (const TMessage &value) |
| Assign a value to Message data member. More... | |
| void | SetMessage (TMessage &&value) |
| TMessage & | SetMessage (void) |
| Assign a value to Message data member. More... | |
| virtual void | Reset (void) |
| Reset the whole object. More... | |
| CIteration_Base (void) | |
| virtual | ~CIteration_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetIter_num (void) const |
| iteration number (use with psiblast) Check if a value has been assigned to Iter_num data member. More... | |
| bool | CanGetIter_num (void) const |
| Check if it is safe to call GetIter_num method. More... | |
| void | ResetIter_num (void) |
| Reset Iter_num data member. More... | |
| TIter_num | GetIter_num (void) const |
| Get the Iter_num member data. More... | |
| void | SetIter_num (TIter_num value) |
| Assign a value to Iter_num data member. More... | |
| TIter_num & | SetIter_num (void) |
| Assign a value to Iter_num data member. More... | |
| bool | IsSetSearch (void) const |
| Check if a value has been assigned to Search data member. More... | |
| bool | CanGetSearch (void) const |
| Check if it is safe to call GetSearch method. More... | |
| void | ResetSearch (void) |
| Reset Search data member. More... | |
| const TSearch & | GetSearch (void) const |
| Get the Search member data. More... | |
| void | SetSearch (TSearch &value) |
| Assign a value to Search data member. More... | |
| TSearch & | SetSearch (void) |
| Assign a value to Search 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 CTypeInfo * | GetThisTypeInfo (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 string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (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... | |
| CObject & | operator= (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 CIteration_Base | Tparent |
| typedef CIteration_Base | Tparent |
Private Member Functions | |
| CIteration (const CIteration &value) | |
| CIteration & | operator= (const CIteration &value) |
| CIteration (const CIteration &value) | |
| CIteration & | operator= (const CIteration &value) |
Additional Inherited Members | |
| Public Types inherited from CIteration_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_iter_num , e_query_ID , e_query_def , e_query_len , e_hits , e_stat , e_message , e__allMandatory = 0 , e_iter_num , e_search } |
| enum class | E_memberIndex { e__allMandatory = 0 , e_iter_num , e_query_ID , e_query_def , e_query_len , e_hits , e_stat , e_message , e__allMandatory = 0 , e_iter_num , e_search } |
| typedef int | TIter_num |
| typedef string | TQuery_ID |
| typedef string | TQuery_def |
| typedef int | TQuery_len |
| typedef list< CRef< CHit > > | THits |
| typedef CStatistics | TStat |
| typedef string | TMessage |
| typedef Tparent::CMemberIndex< E_memberIndex, 8 > | TmemberIndex |
| typedef int | TIter_num |
| typedef CSearch | TSearch |
| typedef Tparent::CMemberIndex< E_memberIndex, 3 > | 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< Uint8 > | TCounter |
| 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
CIteration –.
Definition at line 65 of file Iteration.hpp.
The documentation for this class was generated from the following files:
- include/objects/blastxml/Iteration.hpp
- src/objects/blastxml/Iteration.cpp
