TaskGroup Class Reference

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

Inheritance diagram for TaskGroup:

Public Member Functions
	TaskGroup ()
virtual	~TaskGroup ()
void	addTask (Task *)
void	controlWork (Control) override
void	enableWorkControl (bool=true) override
	Must be called before execute() More...
bool	execute () override
Control	getState () const override
void	getTasks (TaskGroup &)
std::int64_t	nrDone () const override
void	setEmpty ()
void	setParallel (bool)
void	showCumulativeCount (bool yn)
std::int64_t	totalNr () const override
uiString	uiMessage () const override
	will be message() again in 7.x More...
uiString	uiNrDoneText () const override
	will be nrDoneText() in 7.x More...
Public Member Functions inherited from ReportingTask
virtual	~ReportingTask ()
void	getProgress (const ReportingTask &)
Public Member Functions inherited from Task
virtual	~Task ()
virtual uiRetVal	errorWithDetails () const
bool	workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) 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	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
void	stopReceivingNotifications () const
virtual CallBacker *	trueCaller ()
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
virtual BufferString	getName () const
bool	getNameFromPar (const IOPar &)
const name_type &	name () const override
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual void	setName (const char *nm)
Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()
bool	hasName (const char *nm) const
bool	hasName (const name_type &nm) const
void	putNameInPar (IOPar &) const

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

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run , Pause , Stop }
Public Types inherited from ObjectWithName
typedef OD::String	name_type
Static Public Member Functions inherited from Task
static uiString	stdNrDoneText ()
static uiString	uiStdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated
Protected Member Functions inherited from ReportingTask
	ReportingTask (const char *nm=nullptr)
void	incrementProgress ()
ProgressMeter *	progressMeter () const
void	reportProgressFinished ()
void	reportProgressStarted ()
void	resetProgress ()
void	setProgressMeter (ProgressMeter *) override
	Must be called before execute() More...
void	updateProgressMeter (bool forced=false, std::int64_t *totalnr=0)
void	updateReportedName ()
Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Detailed Description

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

<>

Constructor & Destructor Documentation

TaskGroup()

TaskGroup::TaskGroup

(

)

~TaskGroup()

virtual TaskGroup::~TaskGroup ( )

virtual

Member Function Documentation

addTask()

void TaskGroup::addTask

(

Task *

)

controlWork()

void TaskGroup::controlWork ( Control  )

overridevirtual

Reimplemented from Task.

enableWorkControl()

void TaskGroup::enableWorkControl ( bool  = true )

overridevirtual

Must be called before execute()

Reimplemented from Task.

execute()

bool TaskGroup::execute ( )

overridevirtual

Implements Task.

getState()

Control TaskGroup::getState ( ) const

overridevirtual

Reimplemented from Task.

getTasks()

void TaskGroup::getTasks

(

TaskGroup &

)

nrDone()

std::int64_t TaskGroup::nrDone ( ) const

overridevirtual

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.

setEmpty()

void TaskGroup::setEmpty

(

)

setParallel()

void TaskGroup::setParallel

(

bool

)

showCumulativeCount()

void TaskGroup::showCumulativeCount ( bool  yn )

inline

totalNr()

std::int64_t TaskGroup::totalNr ( ) const

overridevirtual

Reimplemented from Task.

uiMessage()

uiString TaskGroup::uiMessage ( ) const

overridevirtual

will be message() again in 7.x

Reimplemented from Task.

uiNrDoneText()

uiString TaskGroup::uiNrDoneText ( ) const

overridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

cumulativecount_

bool TaskGroup::cumulativecount_ = false

protected

curtask_

int TaskGroup::curtask_

protected

lock_

Threads::Lock TaskGroup::lock_

mutableprotected

tasks_

ObjectSet<Task> TaskGroup::tasks_

protected