Search Toolkit Book for CBlast4_queue_search_request_Base
Options have been broken down into three groups as part of the BLAST API work. More...
#include <objects/blast/Blast4_queue_search_reques_.hpp>
Inheritance diagram for CBlast4_queue_search_request_Base:
Collaboration diagram for CBlast4_queue_search_request_Base:
Public Types | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_program , e_service , e_queries , e_subject , e_paramset , e_algorithm_options , e_program_options , e_format_options } |
| typedef string | TProgram |
| typedef string | TService |
| typedef CBlast4_queries | TQueries |
| typedef CBlast4_subject | TSubject |
| typedef string | TParamset |
| typedef CBlast4_parameters | TAlgorithm_options |
| typedef CBlast4_parameters | TProgram_options |
| typedef CBlast4_parameters | TFormat_options |
| typedef Tparent::CMemberIndex< E_memberIndex, 9 > | 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... | |
Public Member Functions | |
| CBlast4_queue_search_request_Base (void) | |
| virtual | ~CBlast4_queue_search_request_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetProgram (void) const |
| Check if a value has been assigned to Program data member. More... | |
| bool | CanGetProgram (void) const |
| Check if it is safe to call GetProgram method. More... | |
| void | ResetProgram (void) |
| Reset Program data member. More... | |
| const TProgram & | GetProgram (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) |
| TProgram & | SetProgram (void) |
| Assign a value to Program data member. More... | |
| bool | IsSetService (void) const |
| Check if a value has been assigned to Service data member. More... | |
| bool | CanGetService (void) const |
| Check if it is safe to call GetService method. More... | |
| void | ResetService (void) |
| Reset Service data member. More... | |
| const TService & | GetService (void) const |
| Get the Service member data. More... | |
| void | SetService (const TService &value) |
| Assign a value to Service data member. More... | |
| void | SetService (TService &&value) |
| TService & | SetService (void) |
| Assign a value to Service data member. More... | |
| bool | IsSetQueries (void) const |
| Check if a value has been assigned to Queries data member. More... | |
| bool | CanGetQueries (void) const |
| Check if it is safe to call GetQueries method. More... | |
| void | ResetQueries (void) |
| Reset Queries data member. More... | |
| const TQueries & | GetQueries (void) const |
| Get the Queries member data. More... | |
| void | SetQueries (TQueries &value) |
| Assign a value to Queries data member. More... | |
| TQueries & | SetQueries (void) |
| Assign a value to Queries data member. More... | |
| bool | IsSetSubject (void) const |
| Check if a value has been assigned to Subject data member. More... | |
| bool | CanGetSubject (void) const |
| Check if it is safe to call GetSubject method. More... | |
| void | ResetSubject (void) |
| Reset Subject data member. More... | |
| const TSubject & | GetSubject (void) const |
| Get the Subject member data. More... | |
| void | SetSubject (TSubject &value) |
| Assign a value to Subject data member. More... | |
| TSubject & | SetSubject (void) |
| Assign a value to Subject data member. More... | |
| bool | IsSetParamset (void) const |
| This field contains a task description Check if a value has been assigned to Paramset data member. More... | |
| bool | CanGetParamset (void) const |
| Check if it is safe to call GetParamset method. More... | |
| void | ResetParamset (void) |
| Reset Paramset data member. More... | |
| const TParamset & | GetParamset (void) const |
| Get the Paramset member data. More... | |
| void | SetParamset (const TParamset &value) |
| Assign a value to Paramset data member. More... | |
| void | SetParamset (TParamset &&value) |
| TParamset & | SetParamset (void) |
| Assign a value to Paramset data member. More... | |
| bool | IsSetAlgorithm_options (void) const |
| Check if a value has been assigned to Algorithm_options data member. More... | |
| bool | CanGetAlgorithm_options (void) const |
| Check if it is safe to call GetAlgorithm_options method. More... | |
| void | ResetAlgorithm_options (void) |
| Reset Algorithm_options data member. More... | |
| const TAlgorithm_options & | GetAlgorithm_options (void) const |
| Get the Algorithm_options member data. More... | |
| void | SetAlgorithm_options (TAlgorithm_options &value) |
| Assign a value to Algorithm_options data member. More... | |
| TAlgorithm_options & | SetAlgorithm_options (void) |
| Assign a value to Algorithm_options data member. More... | |
| bool | IsSetProgram_options (void) const |
| Check if a value has been assigned to Program_options data member. More... | |
| bool | CanGetProgram_options (void) const |
| Check if it is safe to call GetProgram_options method. More... | |
| void | ResetProgram_options (void) |
| Reset Program_options data member. More... | |
| const TProgram_options & | GetProgram_options (void) const |
| Get the Program_options member data. More... | |
| void | SetProgram_options (TProgram_options &value) |
| Assign a value to Program_options data member. More... | |
| TProgram_options & | SetProgram_options (void) |
| Assign a value to Program_options data member. More... | |
| bool | IsSetFormat_options (void) const |
| Check if a value has been assigned to Format_options data member. More... | |
| bool | CanGetFormat_options (void) const |
| Check if it is safe to call GetFormat_options method. More... | |
| void | ResetFormat_options (void) |
| Reset Format_options data member. More... | |
| const TFormat_options & | GetFormat_options (void) const |
| Get the Format_options member data. More... | |
| void | SetFormat_options (TFormat_options &value) |
| Assign a value to Format_options data member. More... | |
| TFormat_options & | SetFormat_options (void) |
| Assign a value to Format_options 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 CSerialObject | Tparent |
Private Member Functions | |
| CBlast4_queue_search_request_Base (const CBlast4_queue_search_request_Base &) | |
| CBlast4_queue_search_request_Base & | operator= (const CBlast4_queue_search_request_Base &) |
Private Attributes | |
| Uint4 | m_set_State [1] |
| string | m_Program |
| string | m_Service |
| CRef< TQueries > | m_Queries |
| CRef< TSubject > | m_Subject |
| string | m_Paramset |
| CRef< TAlgorithm_options > | m_Algorithm_options |
| CRef< TProgram_options > | m_Program_options |
| CRef< TFormat_options > | m_Format_options |
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
Options have been broken down into three groups as part of the BLAST API work.
The algorithm options essentially correspond to those options available via the CBlastOptions class. For definitions of the names used in the Blast4-parameter structures, see c++/{include,src}/objects/blast/names.[hc]pp in the NCBI C++ toolkit. algorithm-options: Options for BLAST (ie. seq comparison) algorithm. program-options: Options for controlling program execution and/or database filtering format-options: Options for formatting BLAST results, clients should use this only if applicable, otherwise they should be ignored
CBlast4_queue_search_request_Base –
Definition at line 89 of file Blast4_queue_search_reques_.hpp.
The documentation for this class was generated from the following files:
- include/objects/blast/Blast4_queue_search_reques_.hpp
- src/objects/blast/Blast4_queue_search_reques_.cpp
