NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
CSeqGraphicJob Class Referenceabstract

Search Toolkit Book for CSeqGraphicJob

CSeqGraphicJob – the base class of seqgraphic job for handling the job status such as reporting the progress and returning the result. More...

#include <gui/widgets/seq_graphic/seqgraphic_job.hpp>

+ Inheritance diagram for CSeqGraphicJob:
+ Collaboration diagram for CSeqGraphicJob:

Public Types

typedef int TJobToken
 
typedef map< string, stringTAnnotNameTitleMap
 List of annotations with the corresponding titles. More...
 
- 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

 CSeqGraphicJob (const string &desc=kEmptyStr)
 CSeqGraphicJob. More...
 
virtual ~CSeqGraphicJob ()
 
void SetToken (TJobToken token)
 CSeqGraphicJob inline methods. More...
 
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...
 
ISeqTaskProgressCallback implementation.
virtual void SetTaskName (const string &name)
 
virtual void SetTaskCompleted (int completed)
 set total finished task number. More...
 
virtual void AddTaskCompleted (int delta)
 set to add newly finished task number. More...
 
virtual void SetTaskTotal (int total)
 
virtual bool StopRequested () const
 
- 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 ISeqTaskProgressCallback
virtual ~ISeqTaskProgressCallback ()
 

Protected Member Functions

virtual EJobState x_Execute ()=0
 method truly doing the job. More...
 
- 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

TJobToken m_Token
 Job token recognizable by job listener. More...
 
Job results and status.
CRef< CAppJobErrorm_Error
 
CRef< CObjectm_Result
 
string m_Desc
 Job description or name. More...
 

Private Attributes

CFastMutex m_Mutex
 mutex for guarding state access More...
 
int m_TaskTotal
 Total amount of task for a job. More...
 
int m_TaskCompleted
 The amount of task finished. More...
 
string m_TaskName
 

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

CSeqGraphicJob – the base class of seqgraphic job for handling the job status such as reporting the progress and returning the result.

Definition at line 51 of file seqgraphic_job.hpp.

Member Typedef Documentation

◆ TAnnotNameTitleMap

List of annotations with the corresponding titles.

Definition at line 59 of file seqgraphic_job.hpp.

◆ TJobToken

Definition at line 56 of file seqgraphic_job.hpp.

Constructor & Destructor Documentation

◆ CSeqGraphicJob()

CSeqGraphicJob::CSeqGraphicJob ( const string desc = kEmptyStr)

CSeqGraphicJob.

Definition at line 56 of file seqgraphic_job.cpp.

References m_Error, CRef< C, Locker >::Reset(), and SetTaskName().

◆ ~CSeqGraphicJob()

virtual CSeqGraphicJob::~CSeqGraphicJob ( )
inlinevirtual

Definition at line 63 of file seqgraphic_job.hpp.

Member Function Documentation

◆ AddTaskCompleted()

void CSeqGraphicJob::AddTaskCompleted ( int  delta)
virtual

◆ GetDescr()

string CSeqGraphicJob::GetDescr ( ) const
virtual

Returns a human readable description of the Job (optional)

Implements IAppJob.

Definition at line 99 of file seqgraphic_job.cpp.

References m_Desc.

◆ GetError()

CConstIRef< IAppJobError > CSeqGraphicJob::GetError ( )
virtual

Returns IAppJobError object describing internal error that caused the Job to fail.

Result shall be returned only if the Job did fail.

Implements IAppJob.

Definition at line 93 of file seqgraphic_job.cpp.

References CRef< C, Locker >::GetPointer(), and m_Error.

◆ GetProgress()

CConstIRef< IAppJobProgress > CSeqGraphicJob::GetProgress ( )
virtual

return progress object, the function shall be synchronized internally.

the returned object should not be modified by the job (job shall create a new instance of Progress object on every GetProgress() invocation).

Implements IAppJob.

Definition at line 75 of file seqgraphic_job.cpp.

References m_Mutex, m_TaskCompleted, m_TaskName, and m_TaskTotal.

◆ GetResult()

CRef< CObject > CSeqGraphicJob::GetResult ( )
virtual

Returns the Job Result.

Derive your own object from CObject and return it from your Job class. Result shall be returned only if Job finished succesfully.

Implements IAppJob.

Definition at line 87 of file seqgraphic_job.cpp.

References m_Result.

◆ Run()

IAppJob::EJobState CSeqGraphicJob::Run ( )
virtual

Function that does all the useful work, called by the Engine.

Run() shall be implemented so that it will allow for exiting once RequestCancel() is called.

Implements IAppJob.

Definition at line 68 of file seqgraphic_job.cpp.

References m_Result, CRef< C, Locker >::Reset(), and x_Execute().

◆ SetTaskCompleted()

void CSeqGraphicJob::SetTaskCompleted ( int  completed)
virtual

◆ SetTaskName()

void CSeqGraphicJob::SetTaskName ( const string name)
virtual

◆ SetTaskTotal()

void CSeqGraphicJob::SetTaskTotal ( int  total)
virtual

◆ SetToken()

void CSeqGraphicJob::SetToken ( TJobToken  token)
inline

◆ StopRequested()

bool CSeqGraphicJob::StopRequested ( ) const
virtual

Implements ISeqTaskProgressCallback.

Definition at line 133 of file seqgraphic_job.cpp.

References CJobCancelable::IsCanceled().

◆ x_Execute()

virtual EJobState CSeqGraphicJob::x_Execute ( )
protectedpure virtual

Member Data Documentation

◆ m_Desc

string CSeqGraphicJob::m_Desc
protected

Job description or name.

Definition at line 93 of file seqgraphic_job.hpp.

Referenced by GetDescr().

◆ m_Error

CRef<CAppJobError> CSeqGraphicJob::m_Error
protected

◆ m_Mutex

CFastMutex CSeqGraphicJob::m_Mutex
private

mutex for guarding state access

Definition at line 99 of file seqgraphic_job.hpp.

Referenced by AddTaskCompleted(), GetProgress(), SetTaskCompleted(), SetTaskName(), and SetTaskTotal().

◆ m_Result

CRef<CObject> CSeqGraphicJob::m_Result
protected

◆ m_TaskCompleted

int CSeqGraphicJob::m_TaskCompleted
private

The amount of task finished.

Definition at line 101 of file seqgraphic_job.hpp.

Referenced by AddTaskCompleted(), GetProgress(), and SetTaskCompleted().

◆ m_TaskName

string CSeqGraphicJob::m_TaskName
private

Definition at line 102 of file seqgraphic_job.hpp.

Referenced by GetProgress(), and SetTaskName().

◆ m_TaskTotal

int CSeqGraphicJob::m_TaskTotal
private

Total amount of task for a job.

Definition at line 100 of file seqgraphic_job.hpp.

Referenced by GetProgress(), and SetTaskTotal().

◆ m_Token

TJobToken CSeqGraphicJob::m_Token
protected

The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:08:33 2024 by modify_doxy.py rev. 669887