ExecutorGroup Class Reference

Executor consisting of other executors. More...

Inheritance diagram for ExecutorGroup:

Public Member Functions
	ExecutorGroup (const char *nm, bool parallel=false, bool ownsexecs=true)
virtual	~ExecutorGroup ()
virtual void	add (Executor *)
Executor *	getExecutor (int idx)
virtual int64_t	nrDone () const
int	nrExecutors ()
void	setNrDoneText (const uiString &txt)
	If set, will use this and the counted nrdone. More...
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...
Public Member Functions inherited from Executor
	Executor (const char *nm)
virtual	~Executor ()
virtual int	doStep ()
virtual bool	execute ()
bool	go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
bool	go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=nullptr)
virtual	~SequentialTask ()
bool	execute ()
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
Public Member Functions inherited from Task
virtual	~Task ()
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
virtual uiRetVal	errorWithDetails () const
virtual Control	getState () 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
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 &)
virtual const name_type &	name () const
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 Member Functions
void	findNextSumStop ()
virtual bool	goToNextExecutor ()
virtual int	nextStep ()
Protected Member Functions inherited from Executor
virtual bool	goImpl (od_ostream *, bool, bool, int)
Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
int	currentexec_
TypeSet< int >	executorres_
ObjectSet< Executor > &	executors_
uiString	nrdonetext_
bool	ownsexecs_
const bool	parallel_
int	sumstart_
int	sumstop_
Protected Attributes inherited from SequentialTask
int	lastupdate_
ProgressMeter *	progressmeter_
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 SequentialTask
static int	ErrorOccurred ()
static int	Finished ()
static int	MoreToDo ()
static int	WarningAvailable ()
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 Executor
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...
Notifier< Executor >	prestep

Detailed Description

Executor consisting of other executors.

Executors may be added on the fly while processing. Depending on the parallel flag, the executors are executed in the order in which they were added or in parallel (but still single-threaded).

<>

Constructor & Destructor Documentation

ExecutorGroup()

ExecutorGroup::ExecutorGroup	(	const char *	nm,
		bool	parallel = false,
		bool	ownsexecs = true
	)

~ExecutorGroup()

virtual ExecutorGroup::~ExecutorGroup ( )

virtual

Member Function Documentation

add()

virtual void ExecutorGroup::add ( Executor *  )

virtual

You will become mine if ownsexecs_ is true!!

findNextSumStop()

void ExecutorGroup::findNextSumStop ( )

protected

getExecutor()

Executor* ExecutorGroup::getExecutor ( int  idx )

inline

goToNextExecutor()

virtual bool ExecutorGroup::goToNextExecutor ( )

protectedvirtual

nextStep()

virtual int ExecutorGroup::nextStep ( )

protectedvirtual

Return values

MoreToDo()	Not finished. Call me again.
Finished()	Nothing more to do.
ErrorOccurred()	Something went wrong.

Note

if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implements SequentialTask.

Reimplemented in EM::dgbSurfaceWriter, and EM::dgbSurfaceReader.

nrDone()

virtual int64_t ExecutorGroup::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.

Reimplemented in Horizon2DGridCreator, EM::dgbSurfaceWriter, and EM::dgbSurfaceReader.

nrExecutors()

int ExecutorGroup::nrExecutors ( )

inline

setNrDoneText()

void ExecutorGroup::setNrDoneText ( const uiString &  txt )

inline

If set, will use this and the counted nrdone.

totalNr()

virtual int64_t ExecutorGroup::totalNr ( ) const

virtual

Reimplemented from Task.

Reimplemented in Horizon2DGridCreator, EM::dgbSurfaceWriter, and EM::dgbSurfaceReader.

uiMessage()

uiString ExecutorGroup::uiMessage ( ) const

virtual

will be message() again in 7.x

Reimplemented from Task.

Reimplemented in EM::dgbSurfaceWriter, and EM::dgbSurfaceReader.

uiNrDoneText()

uiString ExecutorGroup::uiNrDoneText ( ) const

virtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Reimplemented in Horizon2DGridCreator, Seis2DGridCreator, EM::dgbSurfaceWriter, and EM::dgbSurfaceReader.

Member Data Documentation

currentexec_

int ExecutorGroup::currentexec_

protected

executorres_

TypeSet<int> ExecutorGroup::executorres_

protected

executors_

ObjectSet<Executor>& ExecutorGroup::executors_

protected

nrdonetext_

uiString ExecutorGroup::nrdonetext_

protected

ownsexecs_

bool ExecutorGroup::ownsexecs_

protected

parallel_

const bool ExecutorGroup::parallel_

protected

sumstart_

int ExecutorGroup::sumstart_

protected

sumstop_

int ExecutorGroup::sumstop_

protected