SequentialTask Class Reference

The generalization of something (e.g. a computation) where the steps must be done in sequence, i.e. not in parallel. More...

Inheritance diagram for SequentialTask:

Public Member Functions
	SequentialTask (const char *nm=0)
virtual	~SequentialTask ()
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
virtual int	doStep ()
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...

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

Protected Attributes
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_

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

Detailed Description

The generalization of something (e.g. a computation) where the steps must be done in sequence, i.e. not in parallel.

Constructor & Destructor Documentation

SequentialTask::SequentialTask

(

const char *

nm = 0

)

virtual SequentialTask::~SequentialTask ( )

virtual

Member Function Documentation

virtual int SequentialTask::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 in Executor.

static int SequentialTask::ErrorOccurred ( )

inlinestatic

bool SequentialTask::execute ( )

virtual

Implements Task.

static int SequentialTask::Finished ( )

inlinestatic

static int SequentialTask::MoreToDo ( )

inlinestatic

virtual int SequentialTask::nextStep ( )

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

Implemented in Well::SimpleTrackSampler, EM::dgbSurfaceWriter, EM::ChildFinder, Well::LogDataExtracter, uiTreeItemRemover, Well::TrackSampler, Seis::SequentialReader, ExtremeFinderND, VelocityModelScanner, visBase::TileGlueTesselator, Well::InfoCollector, lmkEMStickSetWriter, PreStack::EventDuplicator, BisectionExtremeFinder1D, DataUploader, UnZipper, Seis2DTo3D, SeisBufReader, PreStack::EventImporter, SEGY::FileIndexer, PreStack::EventWriter, Array2DFilterer< T >, EM::dgbSurfDataReader, lmkEMFault3DWriter, EM::dgbSurfaceReader, visBase::TileTesselator, lmkEMStickSetReader, DPSMerger, FileDownloader, Zipper, ExecutorGroup, SeisIOSimple, Table::Converter, SEGYDirect2DLineGetter, SeisCBVS2DLineGetter, JobRunner, Seis2DCopier, PreStack::EventReader, Strat::LayModAttribCalc, Geometry::BulkFaultBinIDSurfaceIntersector, PolyArray1DInterpol, Seis2DLineGetter, SeisImpBPSIF, SeisSingleTraceProc, ExtremeFinder1D, SEGY::ReSorter, lmkEMFault3DReader, LinearArray1DInterpol, SeisImporter, SeisEventSnapper3D, GenericTransformND, Attrib::PosVecOutputGen, VolProc::ChainExecutor, LinSolverTask< T >, HorizonScanner, PreStack::EventExporter, SeisBayesClass, SeisInterpol, VolProc::ChainOutput, HorizonSorter, WaveletExtractor, EM::dgbSurfDataWriter, SeisPSMerger, Hor2DFrom3DCreator, Seis2DLineEventSnapper, MPE::SectionExtender, MPE::SurfaceSourceSelector, Horizon2DScanner, BendPointFinder2DGeomSet, SEGY::Scanner, SeisDataPackWriter, MPE::Horizon2DExtender, Horizon3DTesselator, SeisCubeCopier, MPE::SectionAdjuster, EM::Hor2DTo3D, Seis2DTo3DInterPol, Attrib::Processor, EM::HorizonZTransformer, SeisImpCBVSFromOtherSurvey, SeisMerger, SeisScanner, ArrayNDGentleSmoother< T >, Strat::LayerModelGenerator, SeisRandLineTo2D, StratSynthExporter, Seis2DLineMerger, Seis2DFrom3DExtractor, Vel::FunctionAscIO, MPE::HorizonAdjuster, MPE::SectionSourceSelector, WellTie::SeismicExtractor, MPE::BaseHorizon3DExtender, MPE::BinIDSurfaceSourceSelector, and MPE::Horizon2DSelector.

ProgressMeter* SequentialTask::progressMeter ( )

inline

const ProgressMeter* SequentialTask::progressMeter ( ) const

inline

void SequentialTask::setProgressMeter ( ProgressMeter *  )

virtual

Must be called before execute()

Reimplemented from Task.

Reimplemented in VolProc::ChainOutput.

static int SequentialTask::WarningAvailable ( )

inlinestatic

Member Data Documentation

int SequentialTask::lastupdate_

protected

ProgressMeter* SequentialTask::progressmeter_

protected