NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members
CAnnotMetaDataJob Class Reference

Search Toolkit Book for CAnnotMetaDataJob

CAnnotMetaDataJob. More...

+ Inheritance diagram for CAnnotMetaDataJob:
+ Collaboration diagram for CAnnotMetaDataJob:

Public Member Functions

 CAnnotMetaDataJob (const string &desc, CBioseq_Handle handle, const string &assembly, const string &tms_context)
 CAnnotMetaDataJob implementation. More...
 
virtual ~CAnnotMetaDataJob ()
 
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...
 

Private Attributes

objects::CBioseq_Handle m_Handle
 target sequence More...
 
string m_Assembly
 
string m_TMSContext
 
Job results and status.
CRef< CAppJobErrorm_Error
 
CRef< CAnnotMetaDataJobResultm_Result
 
string m_Desc
 

Additional Inherited Members

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

Detailed Description

CAnnotMetaDataJob.

Definition at line 96 of file feature_panel_ds.cpp.

Constructor & Destructor Documentation

◆ CAnnotMetaDataJob()

CAnnotMetaDataJob::CAnnotMetaDataJob ( const string desc,
CBioseq_Handle  handle,
const string assembly,
const string tms_context 
)

CAnnotMetaDataJob implementation.

Definition at line 256 of file feature_panel_ds.cpp.

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

◆ ~CAnnotMetaDataJob()

virtual CAnnotMetaDataJob::~CAnnotMetaDataJob ( )
inlinevirtual

Definition at line 104 of file feature_panel_ds.cpp.

Member Function Documentation

◆ GetDescr()

string CAnnotMetaDataJob::GetDescr ( ) const
virtual

Returns a human readable description of the Job (optional)

Implements IAppJob.

Definition at line 368 of file feature_panel_ds.cpp.

References m_Desc.

◆ GetError()

CConstIRef< IAppJobError > CAnnotMetaDataJob::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 362 of file feature_panel_ds.cpp.

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

◆ GetProgress()

CConstIRef< IAppJobProgress > CAnnotMetaDataJob::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 350 of file feature_panel_ds.cpp.

References NULL.

◆ GetResult()

CRef< CObject > CAnnotMetaDataJob::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 356 of file feature_panel_ds.cpp.

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

◆ Run()

IAppJob::EJobState CAnnotMetaDataJob::Run ( )
virtual

Member Data Documentation

◆ m_Assembly

string CAnnotMetaDataJob::m_Assembly
private

Definition at line 124 of file feature_panel_ds.cpp.

Referenced by Run().

◆ m_Desc

string CAnnotMetaDataJob::m_Desc
private

Definition at line 120 of file feature_panel_ds.cpp.

Referenced by GetDescr().

◆ m_Error

CRef<CAppJobError> CAnnotMetaDataJob::m_Error
private

Definition at line 118 of file feature_panel_ds.cpp.

Referenced by GetError(), and Run().

◆ m_Handle

objects::CBioseq_Handle CAnnotMetaDataJob::m_Handle
private

target sequence

Definition at line 123 of file feature_panel_ds.cpp.

Referenced by Run().

◆ m_Result

CRef<CAnnotMetaDataJobResult> CAnnotMetaDataJob::m_Result
private

Definition at line 119 of file feature_panel_ds.cpp.

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

◆ m_TMSContext

string CAnnotMetaDataJob::m_TMSContext
private

Definition at line 125 of file feature_panel_ds.cpp.

Referenced by Run().


The documentation for this class was generated from the following file:
Modified on Thu Jul 18 16:06:28 2024 by modify_doxy.py rev. 669887