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	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
void	setEmpty ()
void	getTasks (TaskGroup &)
int64_t	nrDone () const
	Percentage. More...
int64_t	totalNr () const
uiString	message () const
uiString	nrDoneText () const
virtual bool	execute ()
Public Member Functions inherited from TaskGroupController
void	enableWorkControl (bool=true)
	Must be called before execute() More...
void	controlWork (Control)
	Relays to controlled tasks. More...
int	nrTasks () const
const Task *	getTask (int idx) const
Public Member Functions inherited from Task
virtual	~Task ()
virtual uiRetVal	errorWithDetails () const
bool	workControlEnabled () const
virtual Control	getState () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) const
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
virtual bool	isCapsule () const
void	stopReceivingNotifications () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual BufferString	getName () const
virtual void	setName (const char *nm)
bool	getNameFromPar (const IOPar &)
void	putNameInPar (IOPar &) const

Protected Attributes
ObjectSet< Task >	tasks_
int	curtask_
bool	showcumulativecount_
Threads::Lock	lock_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Notifier< NamedCallBacker >	delnotif_
Threads::Atomic< bool >	delalreadytriggered_
Protected Attributes inherited from NamedObject
BufferString	name_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
Static Public Member Functions inherited from Task
static uiString	stdMessage ()
static uiString	stdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Protected Member Functions inherited from TaskGroupController
void	controlTask (Task *)
	Does not take over memory management. More...
void	setEmpty ()
Protected Member Functions inherited from Task
	Task (const char *nm=0)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers () const
	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 *

)

virtual bool TaskGroup::execute ( )

virtual

Implements Task.

void TaskGroup::getTasks

(

TaskGroup &

)

uiString TaskGroup::message ( ) const

virtual

Reimplemented from Task.

int64_t TaskGroup::nrDone ( ) const

virtual

Percentage.

Reimplemented from TaskGroupController.

uiString TaskGroup::nrDoneText ( ) const

virtual

Reimplemented from TaskGroupController.

void TaskGroup::setEmpty

(

)

void TaskGroup::setParallel ( bool  )

inline

void TaskGroup::setProgressMeter ( ProgressMeter *  )

virtual

Must be called before execute()

Reimplemented from Task.

void TaskGroup::showCumulativeCount ( bool  yn )

inline

int64_t TaskGroup::totalNr ( ) const

virtual

Reimplemented from TaskGroupController.

Member Data Documentation

int TaskGroup::curtask_

protected

Threads::Lock TaskGroup::lock_

mutableprotected

bool TaskGroup::showcumulativecount_

protected

ObjectSet<Task> TaskGroup::tasks_

protected