Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCSearchJobBase.html below:
NCBI C++ ToolKit: CSearchJobBase Class Reference
Search Toolkit Book for CSearchJobBase
CSearchJobBase. More...
#include <gui/core/search_tool_base.hpp>
CSearchJobBase () CSearchJobBase. More...
virtual ~CSearchJobBase () void SetFilters (IDMSearchTool::TFilters &filters) int GetResultsCount () const int GetMaxResultsCount () const virtual EJobState Run () Function that does all the useful work, called by the Engine. More...
virtual CConstIRef< IAppJobProgress > GetProgress () return progress object, the function shall be synchronized internally. More...
virtual CRef< CObject > GetResult () Returns the Job Result. More...
virtual CConstIRef< IAppJobError > GetError () Returns IAppJobError object describing internal error that caused the Job to fail. More...
virtual string GetDescr () const Returns a human readable description of the Job (optional) More...
CJobCancelable () void SetDataLocker (ILocker *locker) virtual void RequestCancel () override RequestCancel() is called to notify the Job that it shall exit Run() function ASAP. More...
virtual bool IsCanceled () const override 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...
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 virtual ~IAppJob () virtual bool BeforeRun () Function will be called on the main thread before execution of Run Should not do any lengthy work returns true to continue job execution on worker thread false to quit execution with status - failed. More...
◆ TPatternType ◆ CSearchJobBase() CSearchJobBase::CSearchJobBase ( ) ◆ ~CSearchJobBase() ◆ GetDescr() string CSearchJobBase::GetDescr ( ) const virtual ◆ GetError() ◆ GetMaxResultsCount() int CSearchJobBase::GetMaxResultsCount ( ) const inline ◆ GetProgress() ◆ GetResult() ◆ GetResultsCount() int CSearchJobBase::GetResultsCount ( ) const inline ◆ Run() ◆ SetFilters() ◆ x_DoSearch() virtual EJobState CSearchJobBase::x_DoSearch ( ) protectedpure virtual
performs searching, assuming that params are correct; Implement in derived classes
Implemented in CVcfSearchJob, CSequenceSearchJob, COrfSearchJob, CFeatureSearchJob, CEntrezSearchJob, CCpgSearchJob, CComponentSearchJob, CSNPSearchJob, CNetBLAST_DMSearchJob, and CFeatureSearchJob.
Referenced by Run().
◆ x_GetNewOLTModel() ◆ x_PrepareSearch() void CSearchJobBase::x_PrepareSearch ( ) protectedvirtual
Definition at line 379 of file search_tool_base.cpp.
References CObjectList::Clear(), GetDescr(), CDMSearchResult::GetObjectList(), kDefaultErrMessage, m_AccList, m_Error, m_Mutex, m_ProgressStr, m_Result, m_ResultsCount, m_TempResult, CRef< C, Locker >::Reset(), x_GetNewOLTModel(), and x_SetupColumns().
Referenced by Run().
◆ x_SetupColumns() void CSearchJobBase::x_SetupColumns ( CObjectList & obj_list ) protectedvirtual ◆ x_TransferResults() void CSearchJobBase::x_TransferResults ( ) protectedvirtual
transfer data from Temp Results to Final
Definition at line 404 of file search_tool_base.cpp.
References CObjectList::Append(), CObjectList::ClearRows(), CDMSearchResult::GetObjectList(), m_AccList, m_MaxResultsCount, m_Mutex, m_ProgressStr, m_Result, m_ResultsCount, m_TempResult, CRef< C, Locker >::Reset(), CDMSearchResult::SetIncomplete(), and CDMSearchResult::SetMaxSearchResult().
Referenced by Run().
◆ x_ValidateParams() virtual bool CSearchJobBase::x_ValidateParams ( ) protectedpure virtual
returns true if Job params are correct, implement in derived classes
Implemented in CVcfSearchJob, CSequenceSearchJob, COrfSearchJob, CFeatureSearchJob, CEntrezSearchJob, CCpgSearchJob, CComponentSearchJob, CSNPSearchJob, CNetBLAST_DMSearchJob, and CFeatureSearchJob.
Referenced by Run().
◆ CSearchToolBase::PullSearch ◆ m_AccList ◆ m_Descr string CSearchJobBase::m_Descr protected ◆ m_Error ◆ m_Filters ◆ m_MaxResultsCount int CSearchJobBase::m_MaxResultsCount protected ◆ m_Mutex CMutex CSearchJobBase::m_Mutex protected
synchronizes access to the Job members
Definition at line 218 of file search_tool_base.hpp.
Referenced by GetProgress(), GetResult(), CFeatureSearchJob::x_AddFeatToResults(), CComponentSearchJob::x_AddToResults(), CCpgSearchJob::x_AddToResults(), CSequenceSearchJob::x_AddToResults(), COrfSearchJob::x_AddToResults(), CSNPSearchJob::x_DoSearch(), CComponentSearchJob::x_DoSearch(), CEntrezSearchJob::x_DoSearch(), CVcfSearchJob::x_DoSearch(), x_PrepareSearch(), CFeatureSearchJob::x_SearchFeatures(), CSequenceSearchJob::x_SearchSequence(), and x_TransferResults().
◆ m_ProgressStr string CSearchJobBase::m_ProgressStr protected
Definition at line 233 of file search_tool_base.hpp.
Referenced by GetProgress(), CFeatureSearchJob::x_AddFeatToResults(), CCpgSearchJob::x_AddToResults(), CSequenceSearchJob::x_AddToResults(), COrfSearchJob::x_AddToResults(), CComponentSearchJob::x_DoSearch(), CVcfSearchJob::x_DoSearch(), x_PrepareSearch(), CFeatureSearchJob::x_SearchFeatures(), CSequenceSearchJob::x_SearchSequence(), and x_TransferResults().
◆ m_Result ◆ m_ResultsCount int CSearchJobBase::m_ResultsCount protected ◆ m_TempResult
holds temporary results, guarded by Mutex
Definition at line 231 of file search_tool_base.hpp.
Referenced by GetProgress(), CComponentSearchJob::x_AddToResults(), CCpgSearchJob::x_AddToResults(), CSequenceSearchJob::x_AddToResults(), COrfSearchJob::x_AddToResults(), CSNPSearchJob::x_DoSearch(), CEntrezSearchJob::x_DoSearch(), CVcfSearchJob::x_DoSearch(), x_PrepareSearch(), and x_TransferResults().
The documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4