NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
CBlastSearchTask Class Reference

Search Toolkit Book for CBlastSearchTask

TODO. More...

#include <gui/packages/pkg_alignment/blast_search_task.hpp>

+ Inheritance diagram for CBlastSearchTask:
+ Collaboration diagram for CBlastSearchTask:

Public Types

typedef vector< CRef< CNetBlastJobDescriptor > > TDescriptors
 
- Public Types inherited from CCompositeAppTask
typedef CIRef< IAppTaskTTaskRef
 
- 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...
 
- Public Types inherited from IAppTask
enum  ETaskState {
  eInvalid = -1 , eInitial , eRunning , eBackgrounded ,
  eCompleted , eFailed , eCanceled , eLastState
}
 List of task states defining the task management FSM. More...
 
- Public Types inherited from CEventHandler
enum  EDispatch { eDispatch_SelfOnly , eDispatch_AllHandlers , eDispatch_FirstHandler , eDispatch_Default = eDispatch_AllHandlers }
 enum controlling dispatching strategies More...
 
enum  EPoolName {
  ePool_Default = 0 , ePool_Parent , ePool_Child , ePool_Sibling ,
  ePool_NextAvailable
}
 Identifiers for standard pools. More...
 
typedef vector< CEventHandler * > TListeners
 
typedef map< int, TListenersTPools
 
typedef list< AutoPtr< SPostRequest > > TPostRequests
 
typedef std::map< CEventHandler *, intTHandlerToCount
 
typedef void(* FOnPostCallback) ()
 

Public Member Functions

 CBlastSearchTask (IServiceLocator *srv_locator, CNetBLASTUIDataSource &ds, const string &tool_name)
 CBlastSearchTask. More...
 
virtual ~CBlastSearchTask ()
 
virtual void Init_SubmitSearch (const CBLASTParams &params)
 setup the task for submitting and monitoring BLAST jobs, and for retrieving results More...
 
virtual void Init_Monitoring (TDescriptors &descriptors)
 setup the task for monitoring BLAST jobs and for retrieving results More...
 
virtual void Init_RetrieveRID (const vector< string > &RIDs)
 setup the task for retrieving results More...
 
virtual void SetLoadingOptions (CSelectProjectOptions &options)
 define how the task results shall be handled More...
 
virtual string GetStatusText () const
 overriding CAppTask::GetStatusText() More...
 
- Public Member Functions inherited from CCompositeAppTask
 CCompositeAppTask (const string &descr=kEmptyStr, bool visible=true)
 
void OnTaskEvent (CEvent *event)
 
virtual ETaskState Run ()
 execute the task, this function is called on the main UI thread if a task needs to execute in background it should launch a job that will execute asynchronously; then the function shall return eBackgrounded More...
 
virtual void CancelBackgrounded ()
 make a request to cancel backgrounded task (not called for foreground tasks) More...
 
- Public Member Functions inherited from CAppTask
 CAppTask (const string &descr=kEmptyStr, bool visible=true, int display_delay=0)
 CAppTask. More...
 
virtual ETaskState GetState ()
 returns the current task state More...
 
virtual void OnCancel ()
 this will be called on pending tasks that will be removed from the queue and won't get a chance to run the purpose is to implement any cleanup procedures for the canceled task More...
 
virtual bool IsVisible ()
 returns true if the task should be visible in UI visible task shall represent operations understood by users and usually correspond to menu commands. More...
 
int GetStatusDisplayDelay ()
 returns delay in seconds used for certain fast (and not very important tasks) to only show its status when it is running/pending for long enough More...
 
virtual string GetDescr () const
 returns a human-readable description of the Task (optional) More...
 
virtual void SetListener (CEventHandler *handler)
 set a Listener; this allows a taks running in background to notify the Listener (usually Task Manager) about changes in Status More...
 
virtual IEventLogAction * CreateEventLogAction ()
 returns an action for activating task results (optional, can return NULL) More...
 
- Public Member Functions inherited from CObjectEx
 CObjectEx (void)
 
virtual ~CObjectEx (void)
 
- 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...
 
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 CWeakObject
 CWeakObject (void)
 
virtual ~CWeakObject (void)
 
CPtrToObjectProxyGetPtrProxy (void) const
 Get pointer to proxy object containing pointer to this object. More...
 
- Public Member Functions inherited from IAppTask
virtual ~IAppTask ()
 
- Public Member Functions inherited from CEventHandler
 CEventHandler ()
 CEventHandler. More...
 
virtual ~CEventHandler ()
 
virtual void AddListener (CEventHandler *listener, int pool_name=ePool_Default)
 Add a listener. More...
 
virtual void RemoveListener (CEventHandler *listener)
 Remove a listener. More...
 
virtual void RemoveAllListeners (void)
 
virtual bool HasListener (CEventHandler *listener, int pool_name=ePool_Default) const
 returns "true" if the given listener belongs to the specified pool More...
 
virtual const TListenersGetListeners (int pool_name=ePool_Default) const
 returns a set of listeners fro the specified pool More...
 
virtual bool OnEvent (CEvent *evt)
 Processes en event. Returns "true" if event has been processed. More...
 
virtual bool Dispatch (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Dispatches an event to the listeners (but does not handle it). More...
 
virtual bool Send (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Sends an event synchronously. More...
 
virtual bool Send (CEvent *evt, int pool_name)
 
void Post (CRef< CEvent > evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Handles an event asynchronously (process and/or dispatch). More...
 

Protected Types

enum  ECommand {
  eInvalid = -1 , eSubmit , eMonitor , eRetrieve ,
  eFinished
}
 

Protected Member Functions

void x_InitMonitoringStage (TDescriptors &descriptors)
 preapres App Job for monitoring stage of the task More...
 
void x_ReportErrors (vector< string > &errors)
 
CCompositeAppTask overridables
virtual CIRef< IAppTaskx_GetCurrentSubTask ()
 returns a references to the current subtask More...
 
virtual CIRef< IAppTaskx_NextSubTask ()
 prepares the next subtask (makes it current), this function is used for iterating subtasks. More...
 
virtual ETaskState x_RunCurrentSubTask ()
 runs the current subtask; one may override this function in order to perform special pre-execution or post-execution actions More...
 
- Protected Member Functions inherited from CAppTask
virtual ETaskState x_Run ()
 override this function in derived classes More...
 
virtual bool x_IsFiniteState ()
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from CWeakObject
void CleanWeakRefs (void) const
 Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
 
- Protected Member Functions inherited from CEventHandler
virtual const SEvtMapGetEventMap () const
 
void x_DeclareDead ()
 Removes itself unavailable for async event delivery. More...
 
void x_AddListenerToPool (CEventHandler *listener, int pool_name)
 

Protected Attributes

IServiceLocatorm_SrvLocator
 
CRef< CNetBLASTUIDataSourcem_NetBlastDS
 
string m_ToolName
 name of the tool that launched the task; used in UI More...
 
ECommand m_Command
 the command associated with the task More...
 
CSelectProjectOptions m_LoadingOptions
 
string m_ProjectFolderName
 
CRef< objects::CGBProjectHandle > m_TargetProject
 
ECommand m_Stage
 defines the current stage of the task More...
 
CRef< CNetBlastSubmittingJobm_SubmittingJob
 
CRef< CNetBlastMonitoringJobm_MonitoringJob
 
CRef< CNetBlastLoadingJobm_LoadingJob
 
CIRef< IAppTaskm_CurrTask
 
- Protected Attributes inherited from CAppTask
CEventHandlerm_Listener
 
ETaskState m_State
 
const bool m_Visible
 indicates whether the task is visible More...
 
string m_Descr
 task description More...
 
int m_DisplayDelay
 tasks display delay More...
 
- Protected Attributes inherited from CEventHandler
TPools m_Pools
 

Additional Inherited Members

- Static Public Member Functions inherited from CAppTask
static string StateToString (ETaskState state)
 
- 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 Member Functions inherited from CEventHandler
static bool HandlePostRequest ()
 
static void ClearPostQueue ()
 erases all events from the queue More...
 
static void DestroyPostQueue ()
 
- 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...
 
- Static Protected Attributes inherited from CEventHandler
static const SEvtMap sm_EvtMap
 

Detailed Description

TODO.

Definition at line 57 of file blast_search_task.hpp.


The documentation for this class was generated from the following files:
Modified on Sun Mar 03 03:10:00 2024 by modify_doxy.py rev. 669887