Search Toolkit Book for CLocalBlast
Class to perform a BLAST search on local BLAST databases Note that PHI-BLAST can be run using this class also, one only need to configure it as a regular blastp or blastn search and set the pattern in the CBlastOptionsHandle object. More...
#include <algo/blast/api/local_blast.hpp>
Inheritance diagram for CLocalBlast:
Collaboration diagram for CLocalBlast:
Public Member Functions | |
| CLocalBlast (CRef< IQueryFactory > query_factory, CRef< CBlastOptionsHandle > opts_handle, const CSearchDatabase &dbinfo) | |
| Constructor with database description. More... | |
| CLocalBlast (CRef< IQueryFactory > query_factory, CRef< CBlastOptionsHandle > opts_handle, CRef< CLocalDbAdapter > db) | |
| Constructor with subject adapter (. More... | |
| CLocalBlast (CRef< IQueryFactory > query_factory, CRef< CBlastOptionsHandle > opts_handle, BlastSeqSrc *seqsrc, CRef< IBlastSeqInfoSrc > seqInfoSrc) | |
| Constructor with database description. More... | |
| CRef< CSearchResultSet > | Run () |
| Executes the search. More... | |
| TInterruptFnPtr | SetInterruptCallback (TInterruptFnPtr fnptr, void *user_data=NULL) |
| Set a function callback to be invoked by the CORE of BLAST to allow interrupting a BLAST search in progress. More... | |
| TSearchMessages | GetSearchMessages () const |
| Retrieve any error/warning messages that occurred during the search. More... | |
| Int4 | GetNumExtensions () |
| Retrieve the number of extensions performed during the search. More... | |
| BlastDiagnostics * | GetDiagnostics () |
| Get the diagnostics structure (deep copy, needs to be deleted by caller) More... | |
| void | SetBatchNumber (int batch_num) |
| 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... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. 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 |
| Public Member Functions inherited from CThreadable | |
| CThreadable (void) | |
| Default ctor. More... | |
| virtual | ~CThreadable (void) |
| Our virtual destructor. More... | |
| virtual void | SetNumberOfThreads (size_t nthreads) |
| Mutator for the number of threads. More... | |
| size_t | GetNumberOfThreads (void) const |
| Accessor for the number of threads to use. More... | |
| bool | IsMultiThreaded (void) const |
| Returns true if more than 1 thread is specified. More... | |
Private Attributes | |
| CRef< IQueryFactory > | m_QueryFactory |
| Query factory from which to obtain the query sequence data. More... | |
| CRef< CBlastOptions > | m_Opts |
| Options to use. More... | |
| CRef< SInternalData > | m_InternalData |
| Internal core data structures which are used in the preliminary and traceback stages of the search. More... | |
| CRef< CBlastPrelimSearch > | m_PrelimSearch |
| Object which runs the preliminary stage of the search. More... | |
| CRef< CBlastTracebackSearch > | m_TbackSearch |
| Object which runs the traceback stage of the search. More... | |
| CRef< CLocalDbAdapter > | m_LocalDbAdapter |
| Local DB adaptor (if one was) passed to constructor. More... | |
| CRef< IBlastSeqInfoSrc > | m_SeqInfoSrc |
| User-specified IBlastSeqInfoSrc implementation (may be used for non-standard databases, etc.) More... | |
| TSearchMessages | m_Messages |
| Warnings and error messages. More... | |
| std::string | m_batch_num_str |
Friends | |
| class | ::CBlastFilterTest |
| class | CBl2Seq |
Additional Inherited Members | |
| 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 Types inherited from CThreadable | |
| enum | { kMinNumThreads = 1 } |
| Never have less than 1 thread. More... | |
| 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 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... | |
| Protected Attributes inherited from CThreadable | |
| size_t | m_NumThreads |
| Keep track of how many threads should be used. More... | |
Detailed Description
Class to perform a BLAST search on local BLAST databases Note that PHI-BLAST can be run using this class also, one only need to configure it as a regular blastp or blastn search and set the pattern in the CBlastOptionsHandle object.
Definition at line 61 of file local_blast.hpp.
The documentation for this class was generated from the following files:
- include/algo/blast/api/local_blast.hpp
- src/algo/blast/api/local_blast.cpp
