Specification to enable chunkwise execution of a process. More...

Inherits SequentialTask.

Inherited by Array1DInterpol, Array2DFilterer< T >, ArrayNDGentleSmoother< T >, Attrib::PosVecOutputGen, Attrib::Processor, BendPointFinder2DGeomSet, DPSMerger, EM::dgbSurfDataReader, EM::dgbSurfDataWriter, EM::Hor2DTo3D, EM::HorizonZTransformer, ExecutorGroup, Hor2DFrom3DCreator, Horizon2DScanner, HorizonScanner, HorizonSorter, JobRunner, LinSolverTask< T >, lmkEMFault3DReader, lmkEMStickSetReader, lmkEMStickSetWriter, PreStack::EventDuplicator, PreStack::EventReader, PreStack::EventWriter, SEGY::FileIndexer, SEGY::ReSorter, SEGY::Scanner, Seis2DCopier, Seis2DFrom3DExtractor, Seis2DLineGetter, Seis2DLineMerger, Seis2DTo3D, Seis::SequentialFSLoader, Seis::SequentialPSLoader, SeisBayesClass, SeisBufReader, SeisCubeCopier, SeisDataPackWriter, SeisEventSnapper, SeisImpBPSIF, SeisImpCBVSFromOtherSurvey, SeisImporter, SeisIOSimple, SeisMerger, SeisPSMerger, SeisRandLineTo2D, SeisSingleTraceProc, SeisStatsCalc, Strat::LayerModelGenerator, Strat::LayModAttribCalc, StratSynthExporter, Table::Converter, UnZipper, VolProc::ChainExecutor, VolProc::ChainOutput, WaveletExtractor, Well::InfoCollector, Well::LogDataExtracter, Well::SimpleTrackSampler, Well::TrackSampler, WellTie::SeismicExtractor, and Zipper.

Public Member Functions
	Executor (const char *nm)

virtual	~Executor ()

virtual int	doStep ()

bool	go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)

bool	go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)

virtual bool	execute ()

virtual uiString	message () const =0

virtual uiString	nrDoneText () const =0

virtual int64_t	nrDone () const =0

Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=0)

virtual	~SequentialTask ()

void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...

ProgressMeter *	progressMeter ()

const ProgressMeter *	progressMeter () const

bool	execute ()

Public Member Functions inherited from Task
virtual	~Task ()

virtual int64_t	totalNr () const

virtual uiRetVal	errorWithDetails () const

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

bool	workControlEnabled () const

virtual void	controlWork (Control)

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

Public Attributes
Notifier< Executor >	prestep

Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...

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

Protected Member Functions inherited from SequentialTask
virtual int	nextStep ()=0

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

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }

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

static uiString	stdNrDoneText ()

Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()

static void	removeReceiverForCurrentThread ()

Protected Attributes inherited from SequentialTask
ProgressMeter *	progressmeter_

int	lastupdate_

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_

Detailed Description

Specification to enable chunkwise execution of a process.

Interface enabling separation of the control of execution of any process from what actually is going on. The work is done by calling the doStep() method until either ErrorOccurred or Finished is returned. To enable logging and/or communication with the user, two types of info can be made available (the methods will be called before the step is executed). Firstly, a message. Secondly, info on the progress. It is common that Executors are combined to a new Executor object. This is the most common reason why totalNr() can change.

If doStep returns -1 (Failure) the error message should be in message().

The execute() utility executes the process while logging message() etc. to a stream. Useful in batch situations.

Constructor & Destructor Documentation

Executor::Executor ( const char * nm )

inline

virtual Executor::~Executor ( )

inlinevirtual

Member Function Documentation

virtual int Executor::doStep ( )

virtual

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

Reimplemented from SequentialTask.

virtual bool Executor::execute ( )

inlinevirtual

Implements Task.

bool Executor::go	(	od_ostream *	s = `0`,
		bool	isfirst = `true`,
		bool	islast = `true`,
		int	delaybtwnstepsinms = `0`
	)

inline

bool Executor::go	(	od_ostream &	s,
		bool	isfirst = `true`,
		bool	islast = `true`,
		int	delaybtwnstepsinms = `0`
	)

inline

virtual bool Executor::goImpl	(	od_ostream *	,
		bool	,
		bool	,
		int
	)

protectedvirtual

virtual uiString Executor::message ( ) const

pure virtual

Reimplemented from Task.

Implemented in Well::SimpleTrackSampler, EM::dgbSurfaceWriter, Well::LogDataExtracter, Seis::SequentialPSLoader, Well::TrackSampler, Seis::SequentialFSLoader, PreStack::EventDuplicator, lmkEMStickSetWriter, Well::InfoCollector, PreStack::EventWriter, UnZipper, SEGY::FileIndexer, SeisBufReader, EM::dgbSurfaceReader, EM::dgbSurfDataReader, Array2DFilterer< T >, lmkEMStickSetReader, DPSMerger, Table::Converter, Zipper, ExecutorGroup, JobRunner, SeisIOSimple, PolyArray1DInterpol, Seis2DCopier, Strat::LayModAttribCalc, SeisImpBPSIF, SeisSingleTraceProc, lmkEMFault3DReader, LinearArray1DInterpol, SEGY::ReSorter, Seis2DLineGetter, PreStack::EventReader, SeisEventSnapper3D, LinSolverTask< T >, SeisImporter, WaveletExtractor, SeisBayesClass, EM::dgbSurfDataWriter, Hor2DFrom3DCreator, VolProc::ChainOutput, Seis2DLineEventSnapper, SEGY::Scanner, Attrib::Processor, HorizonSorter, SeisPSMerger, EM::Hor2DTo3D, VolProc::ChainExecutor, SeisDataPackWriter, Attrib::PosVecOutputGen, SeisCubeCopier, Strat::LayerModelGenerator, Seis2DTo3D, BendPointFinder2DGeomSet, StratSynthExporter, SeisMerger, WellTie::SeismicExtractor, SeisImpCBVSFromOtherSurvey, ArrayNDGentleSmoother< T >, Seis2DLineMerger, HorizonScanner, SeisRandLineTo2D, Seis2DFrom3DExtractor, SeisStatsCalc, and Horizon2DScanner.

virtual int64_t Executor::nrDone ( ) const

pure virtual

Note: only used for displaying progress.

Reimplemented from Task.

Implemented in Well::SimpleTrackSampler, EM::dgbSurfaceWriter, Well::LogDataExtracter, Seis::SequentialPSLoader, Well::TrackSampler, Seis::SequentialFSLoader, Well::InfoCollector, PreStack::EventDuplicator, UnZipper, PreStack::EventWriter, SEGY::FileIndexer, SeisBufReader, Array2DFilterer< T >, EM::dgbSurfDataReader, EM::dgbSurfaceReader, DPSMerger, Table::Converter, Zipper, ExecutorGroup, JobRunner, SEGYDirect2DLineGetter, SeisIOSimple, SeisCBVS2DLineGetter, Seis2DCopier, Strat::LayModAttribCalc, Horizon2DGridCreator, SeisImpBPSIF, SeisSingleTraceProc, lmkEMFault3DReader, LinSolverTask< T >, Seis2DLineGetter, SEGY::ReSorter, PreStack::EventReader, SeisImporter, SeisBayesClass, WaveletExtractor, EM::dgbSurfDataWriter, Hor2DFrom3DCreator, VolProc::ChainOutput, SeisPSMerger, SEGY::Scanner, HorizonSorter, EM::Hor2DTo3D, Attrib::Processor, Attrib::PosVecOutputGen, Seis2DTo3D, VolProc::ChainExecutor, SeisCubeCopier, SeisDataPackWriter, Seis2DLineMerger, SeisMerger, ArrayNDGentleSmoother< T >, SeisImpCBVSFromOtherSurvey, SeisRandLineTo2D, BendPointFinder2DGeomSet, HorizonScanner, SeisEventSnapper, WellTie::SeismicExtractor, Array1DInterpol, Strat::LayerModelGenerator, Seis2DFrom3DExtractor, SeisStatsCalc, StratSynthExporter, EM::HorizonZTransformer, and Horizon2DScanner.

virtual uiString Executor::nrDoneText ( ) const

pure virtual

Reimplemented from Task.

Implemented in Well::SimpleTrackSampler, EM::dgbSurfaceWriter, Well::LogDataExtracter, Seis::SequentialPSLoader, Well::TrackSampler, Seis::SequentialFSLoader, PreStack::EventDuplicator, Well::InfoCollector, UnZipper, PreStack::EventWriter, SEGY::FileIndexer, SeisBufReader, Array2DFilterer< T >, EM::dgbSurfDataReader, EM::dgbSurfaceReader, DPSMerger, Table::Converter, Zipper, ExecutorGroup, JobRunner, SeisIOSimple, Seis2DCopier, Strat::LayModAttribCalc, Horizon2DGridCreator, SeisImpBPSIF, SeisSingleTraceProc, lmkEMFault3DReader, SEGY::ReSorter, Seis2DLineGetter, LinSolverTask< T >, PreStack::EventReader, SeisEventSnapper3D, SeisImporter, SeisBayesClass, EM::dgbSurfDataWriter, WaveletExtractor, Hor2DFrom3DCreator, VolProc::ChainOutput, SEGY::Scanner, Seis2DLineEventSnapper, HorizonSorter, Attrib::Processor, SeisPSMerger, EM::Hor2DTo3D, VolProc::ChainExecutor, Seis2DTo3D, SeisDataPackWriter, Attrib::PosVecOutputGen, SeisCubeCopier, SeisMerger, BendPointFinder2DGeomSet, ArrayNDGentleSmoother< T >, SeisImpCBVSFromOtherSurvey, WellTie::SeismicExtractor, HorizonScanner, Strat::LayerModelGenerator, Seis2DLineMerger, StratSynthExporter, SeisRandLineTo2D, EM::HorizonZTransformer, Horizon2DScanner, Array1DInterpol, Seis2DFrom3DExtractor, SeisStatsCalc, and Seis2DGridCreator.

Member Data Documentation

Notifier<Executor> Executor::poststep

Only when MoreToDo will be returned.

Notifier<Executor> Executor::prestep

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation