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

#include <task.h>

Inheritance diagram for SequentialTask:

[legend]

Public Member Functions
	SequentialTask (const char *nm=nullptr)

virtual	~SequentialTask ()

virtual int	doStep ()

bool	execute () override

Public Member Functions inherited from ReportingTask
	ReportingTask (const ReportingTask &)=delete

virtual	~ReportingTask ()

void	getProgress (const ReportingTask &)

ReportingTask &	operator= (const ReportingTask &)=delete

void	setSimpleMeter (bool yn, int repperc)

int	simpleMeterStep () const

bool	useSimpleMeter () const

Public Member Functions inherited from Task
	Task (const Task &)=delete

virtual	~Task ()

virtual void	controlWork (Control)

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

virtual uiRetVal	errorWithDetails () const

virtual Control	getState () const

virtual od_int64	nrDone () const

Task &	operator= (const Task &)=delete

virtual od_int64	totalNr () const

virtual uiString	uiMessage () const

virtual uiString	uiNrDoneText () const

bool	workControlEnabled () const

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=nullptr)

	NamedCallBacker (const NamedCallBacker &)=delete

	~NamedCallBacker ()

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

NamedCallBacker &	operator= (const NamedCallBacker &)=delete

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.

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.

CallBacker &	operator= (const CallBacker &)=delete

void	stopReceivingNotifications () const

virtual CallBacker *	trueCaller ()

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

const name_type &	name () const override

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 ReportingTask
static PtrMan< ProgressMeter >	getTextProgressMeter (od_ostream &, const IOPar *iop=nullptr)

static bool	needSimpleLogging (const IOPar &)

static const char *	sKeySimpleLogging ()

static const char *	sKeySimpleLoggingStep ()

Static Public Member Functions inherited from Task
static uiString	uiStdNrDoneText ()

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

static void	removeReceiverForCurrentThread ()

Protected Member Functions
virtual bool	doFinish (bool success, od_ostream *=nullptr)

virtual bool	doPrepare (od_ostream *=nullptr)

virtual int	nextStep ()=0

Protected Member Functions inherited from ReportingTask
	ReportingTask (const char *nm=nullptr)

void	incrementProgress ()

ProgressMeter *	progressMeter () const

void	reportProgressFinished ()

void	reportProgressStarted ()

void	resetProgress ()

void	setProgressMeter (ProgressMeter *) override
	Must be called before execute()

void	updateProgressMeter (bool forced=false, od_int64 *totalnr=0)

void	updateReportedName ()

Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)

virtual bool	shouldContinue ()

Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

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

Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Protected Attributes inherited from Task
Control	control_ = Task::Run

Threads::ConditionVar *	workcontrolcondvar_ = nullptr

Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_

Notifier< NamedCallBacker >	delnotif_

Protected Attributes inherited from NamedObject
BufferString	name_

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

◆ doFinish()

virtual bool SequentialTask::doFinish	(	bool	success,
		od_ostream *	= nullptr )

protectedvirtual

\will be called after the last nextStep() call

Reimplemented in VelocityModelScanner, SeisImpCBVSFromOtherSurvey, LinearArray1DInterpol, PolyArray1DInterpol, EM::dgbSurfaceReader, and Strat::LayModAttribCalc.

◆ doPrepare()

virtual bool SequentialTask::doPrepare ( od_ostream * = nullptr )

protectedvirtual

\will be called before the 1st nextStep() call

Reimplemented in VelocityModelScanner, ExecutorGroup, EM::dgbSurfaceReader, and SeisInterpol.

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

overridevirtual

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

◆ WarningAvailable()

static int SequentialTask::WarningAvailable ( )

inlinestatic

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SequentialTask()

◆ ~SequentialTask()

Member Function Documentation

◆ doFinish()

◆ doPrepare()

◆ doStep()

◆ ErrorOccurred()

◆ execute()

◆ Finished()

◆ MoreToDo()

◆ nextStep()

◆ WarningAvailable()