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 uiString	message () const
virtual uiString	nrDoneText () const
virtual int64_t	nrDone () const
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

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	stdMessage ()
static uiString	stdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

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 NamedCallBacker
void	sendDelNotif () const
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers () const
	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 NamedCallBacker
Notifier< NamedCallBacker >	delnotif_
Threads::Atomic< bool >	delalreadytriggered_
Protected Attributes inherited from NamedObject
BufferString	name_

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

inlinevirtual

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