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

Search Toolkit Book for CSeqTextJob

CSeqTextJob. More...

#include <gui/widgets/seq_text/seq_text_job.hpp>

+ Inheritance diagram for CSeqTextJob:
+ Collaboration diagram for CSeqTextJob:

Public Types

enum  EJobTask { eLoadFeatureTypesTask }
 
typedef EJobTask TJobTask
 
typedef int TSelectorResolveDepth
 
- 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

 CSeqTextJob (const objects::CSeq_loc &loc, objects::CScope &scope, TJobTask task)
 
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...
 
- 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...
 

Protected Member Functions

void x_LoadFeatureTypes ()
 
- 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

const objects::CSeq_loc & m_Loc
 
objects::CScope & m_Scope
 
objects::SAnnotSelector m_Sel
 
TJobTask m_TaskID
 
CRef< CAppJobProgressm_Progress
 
CRef< CAppJobErrorm_Error
 
CRef< CSeqTextJobResultm_Result
 

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

CSeqTextJob.

Definition at line 77 of file seq_text_job.hpp.

Member Typedef Documentation

◆ TJobTask

Definition at line 84 of file seq_text_job.hpp.

◆ TSelectorResolveDepth

Definition at line 85 of file seq_text_job.hpp.

Member Enumeration Documentation

◆ EJobTask

Enumerator
eLoadFeatureTypesTask 

Definition at line 80 of file seq_text_job.hpp.

Constructor & Destructor Documentation

◆ CSeqTextJob()

CSeqTextJob::CSeqTextJob ( const objects::CSeq_loc &  loc,
objects::CScope &  scope,
TJobTask  task 
)

Definition at line 53 of file seq_text_job.cpp.

References CSeqUtils::GetAnnotSelector(), and m_Sel.

Member Function Documentation

◆ GetDescr()

string CSeqTextJob::GetDescr ( ) const
virtual

Returns a human readable description of the Job (optional)

Implements IAppJob.

Definition at line 124 of file seq_text_job.cpp.

◆ GetError()

CConstIRef< IAppJobError > CSeqTextJob::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 118 of file seq_text_job.cpp.

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

◆ GetProgress()

CConstIRef< IAppJobProgress > CSeqTextJob::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 106 of file seq_text_job.cpp.

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

◆ GetResult()

CRef< CObject > CSeqTextJob::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 112 of file seq_text_job.cpp.

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

◆ Run()

IAppJob::EJobState CSeqTextJob::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 64 of file seq_text_job.cpp.

References IAppJob::eCompleted, eLoadFeatureTypesTask, m_Error, m_Progress, m_Result, m_TaskID, NULL, CRef< C, Locker >::Reset(), and x_LoadFeatureTypes().

◆ x_LoadFeatureTypes()

void CSeqTextJob::x_LoadFeatureTypes ( )
protected

Member Data Documentation

◆ m_Error

CRef<CAppJobError> CSeqTextJob::m_Error
protected

Definition at line 111 of file seq_text_job.hpp.

Referenced by GetError(), and Run().

◆ m_Loc

const objects::CSeq_loc& CSeqTextJob::m_Loc
protected

Definition at line 104 of file seq_text_job.hpp.

Referenced by x_LoadFeatureTypes().

◆ m_Progress

CRef<CAppJobProgress> CSeqTextJob::m_Progress
protected

Definition at line 110 of file seq_text_job.hpp.

Referenced by GetProgress(), and Run().

◆ m_Result

CRef<CSeqTextJobResult> CSeqTextJob::m_Result
protected

Definition at line 112 of file seq_text_job.hpp.

Referenced by GetResult(), Run(), and x_LoadFeatureTypes().

◆ m_Scope

objects::CScope& CSeqTextJob::m_Scope
protected

Definition at line 105 of file seq_text_job.hpp.

Referenced by x_LoadFeatureTypes().

◆ m_Sel

objects::SAnnotSelector CSeqTextJob::m_Sel
protected

Definition at line 106 of file seq_text_job.hpp.

Referenced by CSeqTextJob(), and x_LoadFeatureTypes().

◆ m_TaskID

TJobTask CSeqTextJob::m_TaskID
protected

Definition at line 107 of file seq_text_job.hpp.

Referenced by Run().


The documentation for this class was generated from the following files:
Modified on Sat Jul 13 13:38:38 2024 by modify_doxy.py rev. 669887