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

Search Toolkit Book for CEditAppJob

CEditAppJob - a base class for Jobs modifying existing data in projects. More...

#include <gui/packages/pkg_sequence_edit/edit_job.hpp>

+ Inheritance diagram for CEditAppJob:
+ Collaboration diagram for CEditAppJob:

Public Types

typedef CRef< objects::CProjectItem > TItemRef
 
- 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

 CEditAppJob (CProjectService *service)
 constructor for derived classes More...
 
virtual ~CEditAppJob ()
 
CProjectServiceGetProjectService ()
 
IAppJob implementation
virtual EJobState Run ()
 Function that does all the useful work, called by the Engine. More...
 
virtual CRef< CObjectGetResult ()
 Returns the Job Result. More...
 
- Public Member Functions inherited from CAppJob
 CAppJob (const string &descr="AppJob")
 CAppJob. More...
 
virtual CConstIRef< IAppJobProgressGetProgress () override
 implement Run() in derived classes, make sure that exceptions are handled and m_StopRequested flag is respected. More...
 
virtual CConstIRef< IAppJobErrorGetError () override
 Returns IAppJobError object describing internal error that caused the Job to fail. More...
 
virtual string GetDescr () const override
 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

virtual void x_ResetState ()
 prepares job for execution by clearing state variables More...
 
virtual void x_Run ()
 
virtual void x_MakeChanges ()=0
 override this function in derived classes, populate m_TextResult More...
 
- Protected Member Functions inherited from CAppJob
virtual void x_SetStatusText (const string &text)
 
- 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

CIRef< CProjectServicem_Service
 
string m_TextResult
 
- Protected Attributes inherited from CAppJob
CFastMutex m_Mutex
 
string m_Descr
 mutex to sync our internals More...
 
string m_Status
 Current status of the Job. More...
 
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

CEditAppJob - a base class for Jobs modifying existing data in projects.

Definition at line 58 of file edit_job.hpp.

Member Typedef Documentation

◆ TItemRef

typedef CRef<objects::CProjectItem> CEditAppJob::TItemRef

Definition at line 61 of file edit_job.hpp.

Constructor & Destructor Documentation

◆ CEditAppJob()

CEditAppJob::CEditAppJob ( CProjectService service)

constructor for derived classes

CDataLoadingAppJob.

Definition at line 53 of file edit_job.cpp.

◆ ~CEditAppJob()

CEditAppJob::~CEditAppJob ( )
virtual

Definition at line 59 of file edit_job.cpp.

Member Function Documentation

◆ GetProjectService()

CProjectService * CEditAppJob::GetProjectService ( )

Definition at line 64 of file edit_job.cpp.

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

◆ GetResult()

CRef< CObject > CEditAppJob::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.

Reimplemented from CAppJob.

Definition at line 122 of file edit_job.cpp.

References CAppJob::m_Mutex, m_TextResult, and CRef< C, Locker >::Reset().

◆ Run()

IAppJob::EJobState CEditAppJob::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 70 of file edit_job.cpp.

References IAppJob::eCompleted, IAppJob::eFailed, Error(), CAppJob::GetDescr(), CException::GetMsg(), Info(), LOG_POST, CAppJob::m_Descr, CAppJob::m_Error, CAppJob::m_Mutex, CException::ReportAll(), CRef< C, Locker >::Reset(), x_ResetState(), and x_Run().

◆ x_MakeChanges()

virtual void CEditAppJob::x_MakeChanges ( )
protectedpure virtual

override this function in derived classes, populate m_TextResult

Implemented in CAutodefJob.

Referenced by x_Run().

◆ x_ResetState()

void CEditAppJob::x_ResetState ( )
protectedvirtual

prepares job for execution by clearing state variables

Reimplemented from CAppJob.

Definition at line 103 of file edit_job.cpp.

References kEmptyStr, CAppJob::m_Error, CAppJob::m_Mutex, CAppJob::m_Status, m_TextResult, and CRef< C, Locker >::Reset().

Referenced by Run().

◆ x_Run()

void CEditAppJob::x_Run ( void  )
protectedvirtual

Definition at line 114 of file edit_job.cpp.

References x_MakeChanges().

Referenced by Run().

Member Data Documentation

◆ m_Service

CIRef<CProjectService> CEditAppJob::m_Service
protected

Definition at line 88 of file edit_job.hpp.

Referenced by GetProjectService().

◆ m_TextResult

string CEditAppJob::m_TextResult
protected

Definition at line 90 of file edit_job.hpp.

Referenced by GetResult(), and x_ResetState().


The documentation for this class was generated from the following files:
Modified on Wed Jun 19 17:01:35 2024 by modify_doxy.py rev. 669887