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

Search Toolkit Book for CNetBlastMonitoringJob

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

+ Inheritance diagram for CNetBlastMonitoringJob:
+ Collaboration diagram for CNetBlastMonitoringJob:

Public Types

typedef vector< CRef< CNetBlastJobDescriptor > > TDescriptors
- 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 IAppJob
enum  EJobState {
  eInvalid , eRunning , eCompleted , eFailed ,
  eCanceled , eSuspended
 Job states (describe FSM) More...

Public Member Functions

 CNetBlastMonitoringJob (CNetBLASTUIDataSource &ds, IServiceLocator *srv_locator, const string &tool_name, TDescriptors &descriptors)
 CNetBlastSubmittingJob. More...
virtual void SetLoadingOptions (CSelectProjectOptions &options)
IAppJob implementation
virtual EJobState Run ()
 Function that does all the useful work, called by the Engine. More...
virtual CConstIRef< IAppJobProgressGetProgress ()
 return progress object, the function shall be synchronized internally. More...
virtual CRef< CObjectGetResult ()
 Returns the Job Result. More...
virtual CConstIRef< IAppJobErrorGetError ()
 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...
IWaitPeriod implementation
virtual CTimeSpan GetWaitPeriod ()
 returns a period of time after which the task shall be executed again More...
- Public Member Functions inherited from CJobCancelable
 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
- 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 IAppJob
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...
- Public Member Functions inherited from IWaitPeriod
virtual ~IWaitPeriod ()

Protected Member Functions

EJobState x_Run ()
 this functions performs real work every call to this function does pools each job once, then functions exits if some of jobs are still pending it returns eRunning state, so that it can be executed one more time More...
void x_SetStatusText (const string &text)
void x_ResetState ()
void x_StartRetrivingTask (const vector< string > &RIDs)
- Protected Member Functions inherited from CJobCancelable
CLockerGuard x_GetGuard ()
ICanceledx_GetICanceled ()
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...

Protected Attributes

CFastMutex m_Mutex
string m_ToolName
 mutex to sync our internals More...
CRef< CNetBLASTUIDataSourcem_NetBlastDS
string m_Descr
string m_Status
CSelectProjectOptions m_LoadingOptions
int m_WaitPeriodIndex
TDescriptors m_Descriptors
vector< stringm_Errors
CRef< CAppJobErrorm_Error

Additional Inherited Members

- 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...

Detailed Description

Definition at line 113 of file blast_jobs.hpp.

The documentation for this class was generated from the following files:
Modified on Wed Feb 21 09:55:13 2024 by rev. 669887