Executor Class Reference

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, Geometry::BulkFaultBinIDSurfaceIntersector, Hor2DFrom3DCreator, Horizon2DScanner, HorizonScanner, HorizonSorter, JobRunner, LinSolverTask< T >, lmkEMFault3DReader, lmkEMFault3DWriter, lmkEMStickSetReader, lmkEMStickSetWriter, PreStack::EventDuplicator, PreStack::EventReader, PreStack::EventWriter, SEGY::FileIndexer, SEGY::ReSorter, SEGY::Scanner, Seis2DCopier, Seis2DFrom3DExtractor, Seis2DLineGetter, Seis2DLineMerger, Seis2DTo3D, Seis2DTo3DInterPol, Seis::SequentialReader, SeisBayesClass, SeisBufReader, SeisCubeCopier, SeisDataPackWriter, SeisEventSnapper, SeisImpBPSIF, SeisImpCBVSFromOtherSurvey, SeisImporter, SeisInterpol, SeisIOSimple, SeisMerger, SeisPSMerger, SeisRandLineTo2D, SeisScanner, SeisSingleTraceProc, 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 ()
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	nrDone () const
virtual int64_t	totalNr () const
virtual uiString	uiMessage () const
	will be message() again in 7.x More...
virtual uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...
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 NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject *linkedto)
	NamedObject (const NamedObject &)
virtual	~NamedObject ()
void	setLinkedTo (NamedObject *)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual const OD::String &	annotName () const
virtual void	setName (const char *)
void	setCleanName (const char *)
	cleans string first More...
void	deleteNotify (const CallBack &)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
bool	attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
void	detachCB (NotifierAccess &, const CallBack &)
void	detachCB (NotifierAccess *notif, const CallBack &cb)
bool	isNotifierAttached (NotifierAccess *) const
	Only for debugging purposes, don't use. More...

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 CallBacker
void	detachAllNotifiers ()
	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	stdNrDoneText ()
static uiString	uiStdNrDoneText ()
Protected Attributes inherited from SequentialTask
ProgressMeter *	progressmeter_
int	lastupdate_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

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

The execute() utility executes the process while logging uiMessage() 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

Reimplemented in Seis::SequentialReader.

Member Data Documentation

Notifier<Executor> Executor::poststep

Only when MoreToDo will be returned.

Notifier<Executor> Executor::prestep