Task Class Reference

Generalization of something (e.g. a computation) that needs to be done in multiple steps. More...

#include <task.h>

Inheritance diagram for Task:

Public Types
enum	Control { Run , Pause , Stop }
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
	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 bool	execute ()=0
virtual Control	getState () const
virtual od_int64	nrDone () const
Task &	operator= (const Task &)=delete
virtual void	setProgressMeter (ProgressMeter *)
	Must be called before execute()
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 uiString	uiStdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Protected Member Functions
	Task (const char *nm=nullptr)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

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

Private Member Functions
virtual const char *	message () const
virtual const char *	nrDoneText () const

Detailed Description

Generalization of something (e.g. a computation) that needs to be done in multiple steps.

<>

Member Enumeration Documentation

Control

enum Task::Control

Enumerator
Run
Pause
Stop

Constructor & Destructor Documentation

~Task()

virtual Task::~Task ( )

virtual

Task() [1/2]

Task::Task ( const Task & )

delete

Task() [2/2]

Task::Task ( const char * nm = nullptr )

protected

Member Function Documentation

controlWork()

virtual void Task::controlWork ( Control )

virtual

Reimplemented in TaskGroup, VolProc::ChainOutput, Smoother2D< T >, Smoother3D< T >, Smoother3D< float >, and VolProc::ChainExecutor.

enableWorkControl()

virtual void Task::enableWorkControl ( bool = true )

virtual

Must be called before execute()

Reimplemented in VolProc::ChainOutput, Smoother2D< T >, Smoother3D< T >, Smoother3D< float >, and TaskGroup.

errorWithDetails()

virtual uiRetVal Task::errorWithDetails ( ) const

inlinevirtual

Note

totalNr is only used for displaying progress.

execute()

virtual bool Task::execute ( )

pure virtual

Implemented in Smoother2D< T >, Smoother3D< T >, Smoother3D< float >, Threads::CommandTask, Executor, ParallelTask, TaskGroup, SequentialTask, BitMapGenTask, and uiGraphicsSceneChanger.

getState()

virtual Control Task::getState ( ) const

virtual

Reimplemented in Smoother2D< T >, Smoother3D< T >, Smoother3D< float >, and TaskGroup.

message()

virtual const char * Task::message ( ) const

inlineprivatevirtual

Reimplemented in Geometry::ArrayTesselator, and Seis2DTo3DInterPol.

nrDone()

virtual od_int64 Task::nrDone ( ) const

inlinevirtual

Note

nrDone is only used for displaying progress and will be compared to totalNr to show user how large part of the task that is finished.

Reimplemented in ParallelSorter< T >, Array1DInterpol, ArrayNDGentleSmoother< T >, LinSolverTask< T >, Attrib::PosVecOutputGen, Attrib::Processor, ExecutorGroup, ParallelTask, TaskGroup, EM::Hor2DTo3D, EM::HorizonZTransformer, EM::dgbSurfaceReader, EM::dgbSurfaceWriter, EM::dgbSurfDataWriter, EM::dgbSurfDataReader, EM::SurfaceT2DTransformer, EM::ZMapImporter, Horizon2DScanner, HorizonScanner, HorizonSorter, IsochronMaker, Horizon2DGridCreator, Hor2DFrom3DCreator, SeisEventSnapper, StratAmpCalc, Array2DFilterer< T >, RayTracerRunner, ReflCalcRunner, Table::Converter, Geometry::BulkFaultBinIDSurfaceIntersector, MarchingCubes2Implicit, JobRunner, FileDownloader, DataUploader, PreStack::EventExporter, PreStack::EventImporter, 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, DPSDensityCalcND, DPSMerger, Vel::FunctionAscIO, VolProc::ChainExecutor, VolProc::ChainOutput, LASWriter, MultiWellCopier, Well::DatabaseUpdater, Well::InfoCollector, Well::TrackSampler, Well::LogDataExtracter, Well::SimpleTrackSampler, MultiWellReader, MultiWellWriter, BulkAttribLogCreator, StratSynth::Exporter, WellTie::SeismicExtractor, GMTArray2DInterpol, ODMad::ProcExec, Tut::HorTool, Tut::SeisTools, DZT::Importer, DensityCalc, and Seis2DLineGetter.

nrDoneText()

virtual const char * Task::nrDoneText ( ) const

inlineprivatevirtual

Reimplemented in Seis2DTo3DInterPol.

operator=()

Task & Task::operator= ( const Task & )

delete

setProgressMeter()

virtual void Task::setProgressMeter ( ProgressMeter * )

inlinevirtual

Must be called before execute()

Reimplemented in ReportingTask, and VolProc::ChainOutput.

shouldContinue()

virtual bool Task::shouldContinue ( )

protectedvirtual

Returns

wether we should continue

Reimplemented in BendPointFinder2DGeomSet, and Line2DInterSectionFinder.

totalNr()

virtual od_int64 Task::totalNr ( ) const

inlinevirtual

Reimplemented in ArrayNDGentleSmoother< T >, ContinuousCurvatureArray2DInterpol, LinSolverTask< T >, Attrib::PosVecOutputGen, Attrib::Processor, ExecutorGroup, ParallelTask, TaskGroup, EM::Hor2DTo3D, EM::HorizonZTransformer, EM::dgbSurfaceReader, EM::dgbSurfaceWriter, EM::dgbSurfDataWriter, EM::dgbSurfDataReader, EM::SurfaceT2DTransformer, EM::ZMapImporter, Horizon2DScanner, HorizonScanner, HorizonSorter, IsochronMaker, Horizon2DGridCreator, Hor2DFrom3DCreator, SeisEventSnapper, StratAmpCalc, Array2DFilterer< T >, Geometry::BulkFaultBinIDSurfaceIntersector, JobRunner, FileDownloader, DataUploader, PreStack::AGC, PreStack::EventExporter, PreStack::EventImporter, PreStack::EventDuplicator, SEGYDirect2DLineGetter, SEGY::FileIndexer, SEGY::ReSorter, SEGY::Scanner, Seis2DLineMerger, SeisInterpol, Seis2DTo3D, Seis2DTo3DInterPol, SeisBayesClass, SeisBufReader, SeisCBVS2DLineGetter, SeisImpCBVSFromOtherSurvey, SeisCubeCopier, Seis2DCopier, Seis2DFrom3DExtractor, SeisDataPackWriter, SeisImporter, SeisIOSimple, SeisMerger, Seis::SequentialReader, SeisPSMerger, SeisRandLineTo2D, SeisScanner, SeisSingleTraceProc, VelocityModelScanner, WaveletExtractor, Strat::LayerModelGenerator, Strat::LayModAttribCalc, DPSMerger, Vel::FunctionAscIO, visBase::HorizonTileRenderPreparer, VolProc::ChainExecutor, VolProc::ChainOutput, VolProc::StatsCalculatorTask, LASWriter, MultiWellCopier, Well::DatabaseUpdater, Well::InfoCollector, Well::TrackSampler, Well::LogDataExtracter, Well::SimpleTrackSampler, MultiWellReader, MultiWellWriter, BulkAttribLogCreator, LogCubeCreator, StratSynth::Exporter, WellTie::SeismicExtractor, GMTArray2DInterpol, ODMad::ProcExec, Tut::HorTool, Tut::SeisTools, VolProc::TutOpCalculatorTask, DZT::Importer, and Seis2DLineGetter.

uiMessage()

virtual uiString Task::uiMessage ( ) const

virtual

Reimplemented in lmkEMStickSetReader, lmkEMStickSetWriter, Array2DInterpol, Array2DCopier< T >, Array3DCopier< T >, ArrayMath::CumArrOperExec< RT, AT >, ArrayMath::ArrOperExec< OperType, ArrType >, ArrayMath::CumSumExec< T >, ArrayUdfValReplacer< T >, ArrayUdfValRestorer< T >, Array3DUdfTrcRestorer< T >, MuteArrayExtracter< T >, ObjectSetDeleter< T >, ArrayNDGentleSmoother< T >, BodyVolumeCalculator, Convolver3D< T >, Convolver3D< float >, DelaunayTriangulator, LinSolverTask< T >, RayTracer1D, ReflCalc1D, ZAxisTransformer, Attrib::PosVecOutputGen, Attrib::Processor, ExecutorGroup, MemSetter< T >, MemCopier< T >, MemValReplacer< T >, TaskGroup, EM::Hor2DTo3D, EM::dgbSurfaceReader, EM::dgbSurfaceWriter, EM::dgbSurfDataWriter, EM::dgbSurfDataReader, EM::SurfaceT2DTransformer, EM::ZMapImporter, FaultTraceExtractor, Horizon2DScanner, EM::Horizon3DMerger, HorizonScanner, HorizonSorter, IsochronMaker, lmkEMFault3DReader, lmkEMFault3DWriter, StratAmpCalc, Array2DFilterer< T >, DPSFromVolumeFiller, RayTracerRunner, ReflCalcRunner, Table::Converter, Geometry::BulkFaultBinIDSurfaceIntersector, BendPointFinder2DGeomSet, Line2DInterSectionFinder, Implicit2MarchingCubes, MarchingCubes2Implicit, JobRunner, FileDownloader, DataUploader, PreStack::AngleMuteComputer, PreStack::EventExporter, PreStack::EventImporter, PreStack::EventReader, PreStack::EventWriter, PreStack::EventDuplicator, SEGY::FileIndexer, SEGY::ReSorter, SEGY::Scanner, Seis2DLineGetter, Seis2DLineMerger, SeisInterpol, Seis2DTo3D, SeisBayesClass, SeisBufReader, SeisImpCBVSFromOtherSurvey, SeisCubeCopier, Seis2DCopier, Seis2DFrom3DExtractor, SeisDataPackWriter, SeisImpBPSIF, SeisImporter, SeisIOSimple, SeisMerger, Seis::ParallelReader, Seis::ParallelReader2D, Seis::SequentialReader, SeisPSMerger, SeisRandLineTo2D, SeisScanner, SeisSingleTraceProc, SeisZAxisStretcher, Seis::MultiTraceSynthGenerator, Seis::RaySynthGenerator, VelocityModelScanner, WaveletExtractor, Strat::LayerModelGenerator, Strat::LayModAttribCalc, Vel::VolumeConverter, visBase::HorizonTileResolutionTesselator, visBase::HorizonTileRenderPreparer, visBase::HorizonSectionTilePosSetup, VolProc::ChainExecutor, VolProc::ChainOutput, VolProc::StatsCalculatorTask, MultiWellCopier, Well::InfoCollector, Well::TrackSampler, Well::LogDataExtracter, Well::SimpleTrackSampler, MultiWellReader, MultiWellWriter, BulkAttribLogCreator, StratSynth::Exporter, WellTie::SeismicExtractor, GMTArray2DInterpol, ODMad::ProcExec, Tut::ThicknessCalculator, Tut::HorSmoother, Tut::SeisTools, VolProc::TutOpCalculatorTask, and DZT::Importer.

uiNrDoneText()

virtual uiString Task::uiNrDoneText ( ) const

virtual

Reimplemented in Array1DInterpol, Array2DFromXYConverter, InverseDistanceArray2DInterpol, TriangulationArray2DInterpol, Array2DCopier< T >, Array3DCopier< T >, ArrayMath::CumArrOperExec< RT, AT >, ArrayMath::ArrOperExec< OperType, ArrType >, ArrayMath::CumSumExec< T >, ArrayUdfValReplacer< T >, ArrayUdfValRestorer< T >, Array3DUdfTrcRestorer< T >, MuteArrayExtracter< T >, ObjectSetDeleter< T >, ArrayNDGentleSmoother< T >, BendPointFinderBase, ContinuousCurvatureArray2DInterpol, Convolver3D< T >, Convolver3D< float >, DelaunayTriangulator, LinSolverTask< T >, ZAxisTransformer, Attrib::PosVecOutputGen, Attrib::Processor, ExecutorGroup, MemSetter< T >, MemCopier< T >, MemValReplacer< T >, TaskGroup, EM::Hor2DTo3D, EM::HorizonZTransformer, EM::dgbSurfaceReader, EM::dgbSurfaceWriter, EM::dgbSurfDataWriter, EM::dgbSurfDataReader, EM::SurfaceT2DTransformer, EM::ZMapImporter, Horizon2DScanner, EM::Horizon3DMerger, HorizonScanner, HorizonSorter, IsochronMaker, Seis2DGridCreator, Horizon2DGridCreator, SeisEventSnapper, StratAmpCalc, Array2DFilterer< T >, Array2DReSampler< T, TT >, ColTab::MapperTask< T >, DPSFromVolumeFiller, RayTracerRunner, ReflCalcRunner, Table::Converter, Geometry::ArrayTesselator, Geometry::BulkFaultBinIDSurfaceIntersector, BendPointFinder2DGeomSet, Line2DInterSectionFinder, Implicit2MarchingCubes, FileDownloader, DataUploader, PreStack::AngleMuteComputer, PreStack::EventExporter, PreStack::EventImporter, PreStack::EventDuplicator, SEGY::FileIndexer, SEGY::ReSorter, SEGY::Scanner, Seis2DLineGetter, Seis2DLineMerger, SeisInterpol, Seis2DTo3D, SeisBayesClass, SeisBufReader, SeisImpCBVSFromOtherSurvey, SeisCubeCopier, Seis2DCopier, Seis2DFrom3DExtractor, SeisDataPackWriter, SeisImpBPSIF, SeisImporter, SeisIOSimple, SeisMerger, Seis::ParallelReader, Seis::ParallelReader2D, Seis::SequentialReader, SeisPSMerger, SeisRandLineTo2D, SeisScanner, SeisSingleTraceProc, SeisZAxisStretcher, Seis::RaySynthGenerator, VelocityModelScanner, WaveletExtractor, Strat::LayerModelGenerator, Strat::LayModAttribCalc, DPSDensityCalcND, DPSMerger, Vel::FunctionAscIO, Vel::VolumeConverter, visBase::HorizonTileResolutionTesselator, visBase::HorizonTileRenderPreparer, visBase::HorizonSectionTilePosSetup, VolProc::ChainExecutor, VolProc::ChainOutput, MultiWellCopier, Well::DatabaseUpdater, Well::InfoCollector, Well::TrackSampler, Well::LogDataExtracter, Well::SimpleTrackSampler, Well::LogSampler, MultiWellReader, MultiWellWriter, BulkAttribLogCreator, LogCubeCreator, StratSynth::Exporter, WellTie::SeismicExtractor, ODMad::ProcExec, Tut::HorTool, Tut::SeisTools, DZT::Importer, and DensityCalc.

uiStdNrDoneText()

static uiString Task::uiStdNrDoneText ( )

inlinestatic

workControlEnabled()

bool Task::workControlEnabled

(

)

const

Member Data Documentation

control_

Control Task::control_ = Task::Run

protected

workcontrolcondvar_

Threads::ConditionVar* Task::workcontrolcondvar_ = nullptr

protected