Executor consisting of other executors. More...

#include <executor.h>

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)

od_int64	nrDone () const override

int	nrExecutors ()

void	setNrDoneText (const uiString &txt)
	If set, will use this and the counted nrdone.

od_int64	totalNr () const override

uiString	uiMessage () const override

uiString	uiNrDoneText () const override

Public Member Functions inherited from Executor
	Executor (const char *nm)

virtual	~Executor ()

int	doStep () override

bool	execute () override

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 () override

Public Member Functions inherited from ReportingTask
	ReportingTask (const ReportingTask &)=delete

virtual	~ReportingTask ()

void	getProgress (const ReportingTask &)

ReportingTask &	operator= (const ReportingTask &)=delete

void	setSimpleMeter (bool yn, int repperc)

int	simpleMeterStep () const

bool	useSimpleMeter () const

Public Member Functions inherited from Task
	Task (const Task &)=delete

virtual	~Task ()

virtual void	controlWork (Control)

virtual void	enableWorkControl (bool=true)
	Must be called before execute()

virtual uiRetVal	errorWithDetails () const

virtual Control	getState () const

Task &	operator= (const Task &)=delete

bool	workControlEnabled () const

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=nullptr)

	NamedCallBacker (const NamedCallBacker &)=delete

	~NamedCallBacker ()

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

NamedCallBacker &	operator= (const NamedCallBacker &)=delete

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.

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.

CallBacker &	operator= (const CallBacker &)=delete

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 Member Functions
bool	doPrepare (od_ostream *=nullptr) override

void	findNextSumStop ()

virtual bool	goToNextExecutor ()

int	nextStep () override

Protected Member Functions inherited from Executor
virtual bool	goImpl (od_ostream *, bool, bool, int)

Protected Member Functions inherited from SequentialTask
virtual bool	doFinish (bool success, od_ostream *=nullptr)

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()

void	updateProgressMeter (bool forced=false, od_int64 *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

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 Task
Control	control_ = Task::Run

Threads::ConditionVar *	workcontrolcondvar_ = nullptr

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 ReportingTask
static PtrMan< ProgressMeter >	getTextProgressMeter (od_ostream &, const IOPar *iop=nullptr)

static bool	needSimpleLogging (const IOPar &)

static const char *	sKeySimpleLogging ()

static const char *	sKeySimpleLoggingStep ()

Static Public Member Functions inherited from Task
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.

Notifier< Executor >	prestep

Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

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!!

◆ doPrepare()

bool ExecutorGroup::doPrepare ( od_ostream * = nullptr )

overrideprotectedvirtual

\will be called before the 1st nextStep() call

Reimplemented from SequentialTask.

◆ findNextSumStop()

void ExecutorGroup::findNextSumStop ( )

protected

◆ getExecutor()

Executor * ExecutorGroup::getExecutor ( int idx )

inline

◆ goToNextExecutor()

virtual bool ExecutorGroup::goToNextExecutor ( )

protectedvirtual

◆ nextStep()

int ExecutorGroup::nextStep ( )

overrideprotectedvirtual

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.

◆ nrDone()

od_int64 ExecutorGroup::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.

Reimplemented in Horizon2DGridCreator.

◆ nrExecutors()

int ExecutorGroup::nrExecutors ( )

inline

◆ setNrDoneText()

void ExecutorGroup::setNrDoneText ( const uiString & txt )

inline

If set, will use this and the counted nrdone.

◆ totalNr()

od_int64 ExecutorGroup::totalNr ( ) const

overridevirtual

Reimplemented from Task.

Reimplemented in Horizon2DGridCreator.

◆ uiMessage()

uiString ExecutorGroup::uiMessage ( ) const

overridevirtual

Reimplemented from Task.

◆ uiNrDoneText()

uiString ExecutorGroup::uiNrDoneText ( ) const

overridevirtual

Reimplemented from Task.

Reimplemented in Seis2DGridCreator, and Horizon2DGridCreator.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExecutorGroup()

◆ ~ExecutorGroup()

Member Function Documentation

◆ add()

◆ doPrepare()

◆ findNextSumStop()

◆ getExecutor()

◆ goToNextExecutor()

◆ nextStep()

◆ nrDone()

◆ nrExecutors()

◆ setNrDoneText()

◆ totalNr()

◆ uiMessage()

◆ uiNrDoneText()

Member Data Documentation

◆ currentexec_

◆ executorres_

◆ executors_

◆ nrdonetext_

◆ ownsexecs_

◆ parallel_

◆ sumstart_

◆ sumstop_