Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCAppTask.html below:
NCBI C++ ToolKit: CAppTask Class Reference
Search Toolkit Book for CAppTask
CAppTask - default implementation of IAppTask, use it as a base class for custom tasks. More...
#include <gui/framework/app_task_impl.hpp>
CAppTask (const string &descr=kEmptyStr, bool visible=true, int display_delay=0) CAppTask. More...
virtual ETaskState Run () execute the task, this function is called on the main UI thread if a task needs to execute in background it should launch a job that will execute asynchronously; then the function shall return eBackgrounded More...
virtual ETaskState GetState () returns the current task state More...
virtual void CancelBackgrounded () make a request to cancel backgrounded task (not called for foreground tasks) More...
virtual void OnCancel () this will be called on pending tasks that will be removed from the queue and won't get a chance to run the purpose is to implement any cleanup procedures for the canceled task More...
virtual bool IsVisible () returns true if the task should be visible in UI visible task shall represent operations understood by users and usually correspond to menu commands. More...
int GetStatusDisplayDelay () returns delay in seconds used for certain fast (and not very important tasks) to only show its status when it is running/pending for long enough More...
virtual string GetDescr () const returns a human-readable description of the Task (optional) More...
virtual string GetStatusText () const returns human-readable text describing the current task state More...
virtual void SetListener (CEventHandler *handler) set a Listener; this allows a taks running in background to notify the Listener (usually Task Manager) about changes in Status More...
virtual IEventLogAction * CreateEventLogAction () returns an action for activating task results (optional, can return NULL) More...
CObjectEx (void) virtual ~CObjectEx (void) CObject (void) Constructor. More...
CObject (const CObject &src) Copy constructor. More...
virtual ~CObject (void) Destructor. More...
CObject & operator= (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...
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 CWeakObject (void) virtual ~CWeakObject (void) CPtrToObjectProxy * GetPtrProxy (void) const Get pointer to proxy object containing pointer to this object. More...
virtual ~IAppTask () virtual ETaskState x_Run () override this function in derived classes More...
virtual bool x_IsFiniteState () virtual void DeleteThis (void) Virtual method "deleting" this object. More...
void CleanWeakRefs (void) const Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
enum EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } Control filling of newly allocated memory. More...
typedef CObjectCounterLocker TLockerType Default locker type for CRef. More...
typedef atomic< Uint8 > TCounter Counter type is CAtomiCounter. More...
typedef Uint8 TCount Alias for value type of counter. More...
enum ETaskState {
eInvalid = -1 , eInitial , eRunning , eBackgrounded ,
eCompleted , eFailed , eCanceled , eLastState
} List of task states defining the task management FSM. More...
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...
CAppTask - default implementation of IAppTask, use it as a base class for custom tasks.
Definition at line 51 of file app_task_impl.hpp.
◆ CAppTask() ◆ CancelBackgrounded() void CAppTask::CancelBackgrounded ( ) virtual ◆ CreateEventLogAction() IEventLogAction * CAppTask::CreateEventLogAction ( ) virtual
returns an action for activating task results (optional, can return NULL)
Implements IAppTask.
Definition at line 148 of file app_task_impl.cpp.
References NULL.
◆ GetDescr() string CAppTask::GetDescr ( ) const virtual ◆ GetState() ◆ GetStatusDisplayDelay() int CAppTask::GetStatusDisplayDelay ( ) virtual
returns delay in seconds used for certain fast (and not very important tasks) to only show its status when it is running/pending for long enough
Implements IAppTask.
Definition at line 123 of file app_task_impl.cpp.
References m_DisplayDelay.
◆ GetStatusText() string CAppTask::GetStatusText ( ) const virtual ◆ IsVisible() bool CAppTask::IsVisible ( ) virtual
returns true if the task should be visible in UI visible task shall represent operations understood by users and usually correspond to menu commands.
Implements IAppTask.
Definition at line 118 of file app_task_impl.cpp.
References m_Visible.
◆ OnCancel() void CAppTask::OnCancel ( ) virtual
this will be called on pending tasks that will be removed from the queue and won't get a chance to run the purpose is to implement any cleanup procedures for the canceled task
Implements IAppTask.
Definition at line 113 of file app_task_impl.cpp.
◆ Run()
execute the task, this function is called on the main UI thread if a task needs to execute in background it should launch a job that will execute asynchronously; then the function shall return eBackgrounded
Implements IAppTask.
Reimplemented in CEditAppTask, CJobUITask, CCompositeAppTask, CAppJobTask, CProjectLoadingTask, CObjectLoadingTask, and CDataLoadingAppTask.
Definition at line 68 of file app_task_impl.cpp.
References _ASSERT, IAppTask::eFailed, IAppTask::eInitial, IAppTask::eRunning, kChildFailed, m_State, TASK_CATCH_AND_REPORT, and x_Run().
◆ SetListener()
set a Listener; this allows a taks running in background to notify the Listener (usually Task Manager) about changes in Status
Implements IAppTask.
Definition at line 142 of file app_task_impl.cpp.
References m_Listener.
◆ StateToString() ◆ x_IsFiniteState() bool CAppTask::x_IsFiniteState ( ) protectedvirtual ◆ x_Run() ◆ m_Descr ◆ m_DisplayDelay int CAppTask::m_DisplayDelay protected ◆ m_Listener ◆ m_State
Definition at line 83 of file app_task_impl.hpp.
Referenced by CProjectLoadingTask::CancelBackgrounded(), CAppJobTask::CancelBackgrounded(), CCompositeAppTask::CancelBackgrounded(), GetState(), GetStatusText(), CJobUITask::GetStatusText(), CCompositeAppTask::OnTaskEvent(), CObjectLoadingTask::Run(), CProjectLoadingTask::Run(), CAppJobTask::Run(), Run(), CCompositeAppTask::Run(), CJobUITask::Run(), and x_IsFiniteState().
◆ m_Visible
The documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4