CTaskProgressReporter Class Reference

Search Toolkit Book for CTaskProgressReporter

Tasks that report progress derive from this class. More...

#include <objtools/alnmgr/task_progress.hpp>

Inheritance diagram for CTaskProgressReporter:

Collaboration diagram for CTaskProgressReporter:

Public Member Functions
	CTaskProgressReporter ()
	Constructor. More...
void	SetTaskProgressCallback (ITaskProgressCallback *callback)
	Hook a callback to a task. More...

Protected Member Functions
void	x_SetTaskName (const string &name)
	Methods for reporting task progress. More...
void	x_SetTaskCompleted (int completed)
void	x_SetTaskTotal (int total)
bool	x_InterruptTask ()
	Check if the task should be interrupted. More...
ITaskProgressCallback *	x_GetTaskProgressCallback () const
	Callback accessor. More...

Private Attributes
ITaskProgressCallback *	m_Callback

Detailed Description

Tasks that report progress derive from this class.

Definition at line 53 of file task_progress.hpp.

Constructor & Destructor Documentation

CTaskProgressReporter()

CTaskProgressReporter::CTaskProgressReporter ( )

inline

Constructor.

Definition at line 59 of file task_progress.hpp.

Member Function Documentation

SetTaskProgressCallback()

void CTaskProgressReporter::SetTaskProgressCallback ( ITaskProgressCallback *  callback )

inline

Hook a callback to a task.

Definition at line 62 of file task_progress.hpp.

References m_Callback.

Referenced by CBuildAlnVecJob::Build(), CAlnMix::Merge(), and CAlnMrgApp::Run().

x_GetTaskProgressCallback()

ITaskProgressCallback* CTaskProgressReporter::x_GetTaskProgressCallback ( ) const

inlineprotected

Callback accessor.

Definition at line 93 of file task_progress.hpp.

References m_Callback.

Referenced by CAlnMix::Merge().

x_InterruptTask()

bool CTaskProgressReporter::x_InterruptTask ( )

inlineprotected

Check if the task should be interrupted.

Definition at line 85 of file task_progress.hpp.

References ITaskProgressCallback::InterruptTask(), and m_Callback.

Referenced by CAlnMixMerger::x_Merge().

x_SetTaskCompleted()

void CTaskProgressReporter::x_SetTaskCompleted ( int  completed )

inlineprotected

Definition at line 73 of file task_progress.hpp.

References m_Callback, and ITaskProgressCallback::SetTaskCompleted().

Referenced by CAlnMixMerger::x_CreateDenseg(), and CAlnMixMerger::x_Merge().

x_SetTaskName()

void CTaskProgressReporter::x_SetTaskName ( const string &  name )

inlineprotected

Methods for reporting task progress.

Definition at line 68 of file task_progress.hpp.

References m_Callback, and ITaskProgressCallback::SetTaskName().

Referenced by CAlnMix::Merge(), and CAlnMixMerger::x_CreateDenseg().

x_SetTaskTotal()

void CTaskProgressReporter::x_SetTaskTotal ( int  total )

inlineprotected

Definition at line 78 of file task_progress.hpp.

References m_Callback, and ITaskProgressCallback::SetTaskTotal().

Referenced by CAlnMixMerger::x_CreateDenseg(), and CAlnMixMerger::x_Merge().

Member Data Documentation

m_Callback

ITaskProgressCallback* CTaskProgressReporter::m_Callback

private

Definition at line 98 of file task_progress.hpp.

Referenced by SetTaskProgressCallback(), x_GetTaskProgressCallback(), x_InterruptTask(), x_SetTaskCompleted(), x_SetTaskName(), and x_SetTaskTotal().

---

The documentation for this class was generated from the following file:

• include/objtools/alnmgr/task_progress.hpp