NCBI C++ ToolKit
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
CTextRetrieveJob Class Referenceabstract

Search Toolkit Book for CTextRetrieveJob

#include <gui/widgets/seq/text_retrieve_job.hpp>

+ Inheritance diagram for CTextRetrieveJob:
+ Collaboration diagram for CTextRetrieveJob:

Classes

class  CCancelException
 

Public Member Functions

 CTextRetrieveJob (CTextPanelContext &context)
 
 ~CTextRetrieveJob ()
 
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...
 
- 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...
 
virtual string GetDescr () const =0
 Returns a human readable description of the Job (optional) More...
 

Protected Member Functions

virtual string x_GetJobName () const =0
 
virtual EJobState x_Run ()=0
 
void x_CheckCancelled () const
 
void x_AddItem (ITextItem *item)
 
void x_AddItems (vector< ITextItem * > &items)
 
void x_CreateResult ()
 
- 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

CRef< CTextViewRetrieveResultm_Result
 
CRef< CAppJobErrorm_Error
 
CFastMutex m_Mutex
 
shared_ptr< CRootTextItemm_RootItem
 
shared_ptr< CTextPanelContextm_Context
 

Friends

class CFlatFileFactoryBuilder
 

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

Detailed Description

Definition at line 48 of file text_retrieve_job.hpp.

Constructor & Destructor Documentation

◆ CTextRetrieveJob()

CTextRetrieveJob::CTextRetrieveJob ( CTextPanelContext context)
inline

Definition at line 51 of file text_retrieve_job.hpp.

◆ ~CTextRetrieveJob()

CTextRetrieveJob::~CTextRetrieveJob ( )

Definition at line 42 of file text_retrieve_job.cpp.

References CAtomicCounter::Get(), gITextItemCount, Info(), and LOG_POST.

Member Function Documentation

◆ GetError()

CConstIRef< IAppJobError > CTextRetrieveJob::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 145 of file text_retrieve_job.cpp.

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

◆ GetProgress()

CConstIRef< IAppJobProgress > CTextRetrieveJob::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 135 of file text_retrieve_job.cpp.

◆ GetResult()

CRef< CObject > CTextRetrieveJob::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 140 of file text_retrieve_job.cpp.

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

◆ Run()

IAppJob::EJobState CTextRetrieveJob::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 49 of file text_retrieve_job.cpp.

References IAppJob::eCanceled, IAppJob::eCompleted, IAppJob::eFailed, Error(), IAppJob::GetDescr(), CException::GetMsg(), CJobCancelable::IsCanceled(), LOG_POST, m_Error, m_RootItem, CRef< C, Locker >::Reset(), CException::what(), CJobCancelable::x_GetGuard(), x_GetJobName(), and x_Run().

◆ x_AddItem()

void CTextRetrieveJob::x_AddItem ( ITextItem item)
protected

◆ x_AddItems()

void CTextRetrieveJob::x_AddItems ( vector< ITextItem * > &  items)
protected

Definition at line 98 of file text_retrieve_job.cpp.

References m_RootItem.

◆ x_CheckCancelled()

void CTextRetrieveJob::x_CheckCancelled ( ) const
protected

◆ x_CreateResult()

void CTextRetrieveJob::x_CreateResult ( )
protected

◆ x_GetJobName()

virtual string CTextRetrieveJob::x_GetJobName ( ) const
protectedpure virtual

◆ x_Run()

virtual EJobState CTextRetrieveJob::x_Run ( )
protectedpure virtual

Friends And Related Function Documentation

◆ CFlatFileFactoryBuilder

friend class CFlatFileFactoryBuilder
friend

Definition at line 80 of file text_retrieve_job.hpp.

Member Data Documentation

◆ m_Context

shared_ptr<CTextPanelContext> CTextRetrieveJob::m_Context
protected

Definition at line 78 of file text_retrieve_job.hpp.

Referenced by x_CreateResult().

◆ m_Error

CRef<CAppJobError> CTextRetrieveJob::m_Error
protected

Definition at line 74 of file text_retrieve_job.hpp.

Referenced by GetError(), Run(), and CFlatFeatureRetrieveJob::x_Run().

◆ m_Mutex

CFastMutex CTextRetrieveJob::m_Mutex
protected

Definition at line 76 of file text_retrieve_job.hpp.

Referenced by x_CreateResult().

◆ m_Result

CRef<CTextViewRetrieveResult> CTextRetrieveJob::m_Result
protected

Definition at line 73 of file text_retrieve_job.hpp.

Referenced by GetResult(), and x_CreateResult().

◆ m_RootItem

shared_ptr<CRootTextItem> CTextRetrieveJob::m_RootItem
protected

The documentation for this class was generated from the following files:
Modified on Sun Jul 14 04:58:53 2024 by modify_doxy.py rev. 669887