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=nullptr)
virtual	~SequentialTask ()
virtual int	doStep ()
bool	execute ()
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
Public Member Functions inherited from Task
virtual	~Task ()
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
virtual uiRetVal	errorWithDetails () const
virtual Control	getState () const
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...
bool	workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
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. More...
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. More...
void	stopReceivingNotifications () const
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 &)
virtual const name_type &	name () const
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

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 ()
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=nullptr)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
int	lastupdate_
ProgressMeter *	progressmeter_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
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

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::SequentialTask

(

const char *

nm = nullptr

)

~SequentialTask()

virtual SequentialTask::~SequentialTask ( )

virtual

Member Function Documentation

doStep()

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.

ErrorOccurred()

static int SequentialTask::ErrorOccurred ( )

inlinestatic

execute()

bool SequentialTask::execute ( )

virtual

Implements Task.

Finished()

static int SequentialTask::Finished ( )

inlinestatic

MoreToDo()

static int SequentialTask::MoreToDo ( )

inlinestatic

nextStep()

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

progressMeter() [1/2]

ProgressMeter* SequentialTask::progressMeter ( )

inline

progressMeter() [2/2]

const ProgressMeter* SequentialTask::progressMeter ( ) const

inline

setProgressMeter()

void SequentialTask::setProgressMeter ( ProgressMeter *  )

virtual

Must be called before execute()

Reimplemented from Task.

Reimplemented in VolProc::ChainOutput.

WarningAvailable()

static int SequentialTask::WarningAvailable ( )

inlinestatic

Member Data Documentation

lastupdate_

int SequentialTask::lastupdate_

protected

progressmeter_

ProgressMeter* SequentialTask::progressmeter_

protected