TaskGroup Class Reference

A collection of tasks, that behave as a single task. More...

Inheritance diagram for TaskGroup:

Public Member Functions
	TaskGroup ()
	~TaskGroup ()
void	addTask (Task *)
void	setParallel (bool)
void	showCumulativeCount (bool yn)
void	setEmpty ()
void	getTasks (TaskGroup &)
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
virtual int64_t	nrDone () const
virtual int64_t	totalNr () const
uiString	uiMessage () const
	will be message() again in 7.x More...
uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...
virtual bool	execute ()
void	enableWorkControl (bool=true)
	Must be called before execute() More...
virtual void	controlWork (Control)
virtual Control	getState () const
Public Member Functions inherited from Task
virtual	~Task ()
bool	workControlEnabled () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject *linkedto)
	NamedObject (const NamedObject &)
virtual	~NamedObject ()
void	setLinkedTo (NamedObject *)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual const OD::String &	annotName () const
virtual void	setName (const char *)
void	setCleanName (const char *)
	cleans string first More...
void	deleteNotify (const CallBack &)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
bool	attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
void	detachCB (NotifierAccess &, const CallBack &)
void	detachCB (NotifierAccess *notif, const CallBack &cb)
bool	isNotifierAttached (NotifierAccess *) const
	Only for debugging purposes, don't use. More...

Protected Attributes
ObjectSet< Task >	tasks_
int	curtask_
Threads::Lock	lock_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

Private Member Functions
void	cleanUp ()

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
Static Public Member Functions inherited from Task
static uiString	stdNrDoneText ()
static uiString	uiStdNrDoneText ()
Protected Member Functions inherited from Task
	Task (const char *nm=0)
virtual bool	shouldContinue ()
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Detailed Description

A collection of tasks, that behave as a single task.

Constructor & Destructor Documentation

TaskGroup::TaskGroup

(

)

TaskGroup::~TaskGroup ( )

inline

Member Function Documentation

void TaskGroup::addTask

(

Task *

)

void TaskGroup::cleanUp ( )

private

virtual void TaskGroup::controlWork ( Control  )

virtual

Reimplemented from Task.

void TaskGroup::enableWorkControl ( bool  = true )

virtual

Must be called before execute()

Reimplemented from Task.

virtual bool TaskGroup::execute ( )

virtual

Implements Task.

virtual Control TaskGroup::getState ( ) const

virtual

Reimplemented from Task.

void TaskGroup::getTasks

(

TaskGroup &

)

virtual int64_t TaskGroup::nrDone ( ) const

virtual

Note

nrDone is only used for displaying progress and will be compared to totalNr to show user how large part of the task that is finished.

Reimplemented from Task.

void TaskGroup::setEmpty

(

)

void TaskGroup::setParallel

(

bool

)

void TaskGroup::setProgressMeter ( ProgressMeter *  )

virtual

Must be called before execute()

Reimplemented from Task.

void TaskGroup::showCumulativeCount

(

bool

yn

)

virtual int64_t TaskGroup::totalNr ( ) const

virtual

Reimplemented from Task.

uiString TaskGroup::uiMessage ( ) const

virtual

will be message() again in 7.x

Note

totalNr is only used for displaying progress.

Reimplemented from Task.

uiString TaskGroup::uiNrDoneText ( ) const

virtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

int TaskGroup::curtask_

protected

Threads::Lock TaskGroup::lock_

mutableprotected

ObjectSet<Task> TaskGroup::tasks_

protected