Task Class Reference

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

Inheritance diagram for Task:

Public Types
enum	Control { Run, Pause, Stop }

Public Member Functions
virtual	~Task ()
virtual void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
virtual uiString	message () const
virtual uiString	nrDoneText () const
virtual int64_t	nrDone () const
virtual int64_t	totalNr () const
virtual uiRetVal	errorWithDetails () const
virtual bool	execute ()=0
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 uiString	stdMessage ()
static uiString	stdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Protected Member Functions
	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
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Notifier< NamedCallBacker >	delnotif_
Threads::Atomic< bool >	delalreadytriggered_
Protected Attributes inherited from NamedObject
BufferString	name_

Static Private Member Functions
static uiString	tr (const char *text, const char *disambiguation=0, int pluralnr=-1)
static uiString	legacyTr (const char *text, const char *disambiguation=0, int pluralnr=-1)

Detailed Description

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

Member Enumeration Documentation

enum Task::Control

Enumerator
Run
Pause
Stop

Constructor & Destructor Documentation

virtual Task::~Task ( )

virtual

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

protected

Member Function Documentation

virtual void Task::controlWork ( Control  )

virtual

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

virtual void Task::enableWorkControl ( bool  = true )

virtual

Must be called before execute()

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

virtual uiRetVal Task::errorWithDetails ( ) const

inlinevirtual

Note

only used for displaying progress.

virtual bool Task::execute ( )

pure virtual

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

virtual Control Task::getState ( ) const

virtual

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

static uiString Task::legacyTr ( const char *  text, const char *  disambiguation = 0, int  pluralnr = -1  )

inlinestaticprivate

virtual uiString Task::message ( ) const

inlinevirtual

Reimplemented in Array3DUdfTrcRestorer< T >, ArrayUdfValRestorer< T >, ArrayUdfValReplacer< T >, Array3DCopier< T >, Array2DCopier< T >, Well::SimpleTrackSampler, EM::dgbSurfaceWriter, DPSFromVolumeFiller, ArrayMath::ArrOperExec< ArrType, SumType, OperType >, Well::LogDataExtracter, Seis::SequentialPSLoader, Well::TrackSampler, Seis::SequentialFSLoader, Seis::MultiTraceSynthGenerator, DelaunayTriangulator, MarchingCubes2Implicit, FaultTraceExtractor, VelocityModelScanner, PreStack::EventDuplicator, MemValReplacer< T >, lmkEMStickSetWriter, Well::InfoCollector, DataUploader, Seis::ParallelFSLoader2D, Implicit2MarchingCubes, TaskGroup, PreStack::EventWriter, UnZipper, visBase::HorizonSectionTilePosSetup, Line2DInterSectionFinder, SEGY::FileIndexer, PreStack::EventImporter, SeisBufReader, EM::dgbSurfaceReader, EM::dgbSurfDataReader, Array2DFilterer< T >, FileDownloader, lmkEMStickSetReader, Seis::ParallelFSLoader3D, MemCopier< T >, DPSMerger, Array2DInterpol, Table::Converter, Zipper, ExecutorGroup, JobRunner, SeisIOSimple, PolyArray1DInterpol, VolProc::StatsCalculatorTask, Seis2DCopier, ArrayMath::CumArrOperExec< ArrType, SumType, OperType, RetType >, visBase::HorizonTileRenderPreparer, Strat::LayModAttribCalc, SeisImpBPSIF, SeisSingleTraceProc, lmkEMFault3DReader, LinearArray1DInterpol, SEGY::ReSorter, Seis2DLineGetter, Executor, PreStack::EventReader, SeisEventSnapper3D, LinSolverTask< T >, SeisImporter, WaveletExtractor, MemSetter< T >, SeisBayesClass, PreStack::EventExporter, EM::dgbSurfDataWriter, PreStack::AngleMuteComputer, Hor2DFrom3DCreator, VolProc::ChainOutput, Seis2DLineEventSnapper, SEGY::Scanner, Attrib::Processor, RaySynthGenerator, visBase::HorizonTileResolutionTesselator, ZAxisTransformer, Geometry::ArrayTesselator, HorizonSorter, SeisPSMerger, SeisZAxisStretcher, Convolver3D< T >, EM::Hor2DTo3D, VolProc::ChainExecutor, Convolver3D< float >, SeisDataPackWriter, Attrib::PosVecOutputGen, BodyVolumeCalculator, SeisCubeCopier, Strat::LayerModelGenerator, Seis2DTo3D, BendPointFinder2DGeomSet, StratSynthExporter, SeisMerger, WellTie::SeismicExtractor, SeisImpCBVSFromOtherSurvey, ArrayNDGentleSmoother< T >, Seis2DLineMerger, HorizonScanner, SeisRandLineTo2D, Seis2DFrom3DExtractor, SeisStatsCalc, and Horizon2DScanner.

virtual int64_t Task::nrDone ( ) const

inlinevirtual

Note

only used for displaying progress.

Reimplemented in Well::SimpleTrackSampler, EM::dgbSurfaceWriter, Well::LogDataExtracter, Seis::SequentialPSLoader, Well::TrackSampler, Seis::SequentialFSLoader, MarchingCubes2Implicit, VelocityModelScanner, Well::InfoCollector, PreStack::EventDuplicator, DataUploader, ParallelSorter< T >, TaskGroup, UnZipper, PreStack::EventWriter, SEGY::FileIndexer, SeisBufReader, PreStack::EventImporter, Array2DFilterer< T >, FileDownloader, EM::dgbSurfDataReader, EM::dgbSurfaceReader, DPSMerger, Table::Converter, Zipper, ExecutorGroup, JobRunner, SEGYDirect2DLineGetter, SeisIOSimple, SeisCBVS2DLineGetter, ParallelTask, Seis2DCopier, Strat::LayModAttribCalc, TaskGroupController, Horizon2DGridCreator, SeisImpBPSIF, SeisSingleTraceProc, lmkEMFault3DReader, LinSolverTask< T >, Seis2DLineGetter, RaySynthGenerator, SEGY::ReSorter, Executor, PreStack::EventReader, SeisImporter, SeisBayesClass, WaveletExtractor, EM::dgbSurfDataWriter, PreStack::EventExporter, Hor2DFrom3DCreator, VolProc::ChainOutput, SeisPSMerger, SEGY::Scanner, HorizonSorter, EM::Hor2DTo3D, Attrib::Processor, Attrib::PosVecOutputGen, Seis2DTo3D, VolProc::ChainExecutor, SeisCubeCopier, SeisDataPackWriter, Vel::FunctionAscIO, Seis2DLineMerger, SeisMerger, DPSDensityCalcND, ArrayNDGentleSmoother< T >, SeisImpCBVSFromOtherSurvey, SeisRandLineTo2D, DensityCalc, BendPointFinder2DGeomSet, HorizonScanner, SeisEventSnapper, WellTie::SeismicExtractor, Array1DInterpol, RayTracerRunner, Strat::LayerModelGenerator, Seis2DFrom3DExtractor, SeisStatsCalc, StratSynthExporter, EM::HorizonZTransformer, and Horizon2DScanner.

virtual uiString Task::nrDoneText ( ) const

inlinevirtual

Reimplemented in Array3DUdfTrcRestorer< T >, ArrayUdfValRestorer< T >, ArrayUdfValReplacer< T >, Array3DCopier< T >, Array2DCopier< T >, Well::SimpleTrackSampler, DPSFromVolumeFiller, EM::dgbSurfaceWriter, ArrayMath::ArrOperExec< ArrType, SumType, OperType >, Well::LogDataExtracter, Seis::SequentialPSLoader, Well::TrackSampler, Seis::SequentialFSLoader, DelaunayTriangulator, TriangulationArray2DInterpol, MarchingCubes2Implicit, VelocityModelScanner, PreStack::EventDuplicator, MemValReplacer< T >, DataUploader, Well::InfoCollector, Seis::ParallelFSLoader2D, TaskGroup, UnZipper, visBase::HorizonSectionTilePosSetup, PreStack::EventWriter, SEGY::FileIndexer, PreStack::EventImporter, Line2DInterSectionFinder, SeisBufReader, Array2DFilterer< T >, EM::dgbSurfDataReader, FileDownloader, MemCopier< T >, EM::dgbSurfaceReader, Seis::ParallelFSLoader3D, DPSMerger, Table::Converter, Zipper, ExecutorGroup, JobRunner, SeisIOSimple, InverseDistanceArray2DInterpol, Seis2DCopier, TaskGroupController, ArrayMath::CumArrOperExec< ArrType, SumType, OperType, RetType >, visBase::HorizonTileRenderPreparer, Strat::LayModAttribCalc, Array2DReSampler< T, TT >, Horizon2DGridCreator, SeisImpBPSIF, SeisSingleTraceProc, lmkEMFault3DReader, RaySynthGenerator, SEGY::ReSorter, Seis2DLineGetter, LinSolverTask< T >, Executor, PreStack::EventReader, SeisEventSnapper3D, SeisImporter, PreStack::EventExporter, MemSetter< T >, SeisBayesClass, EM::dgbSurfDataWriter, WaveletExtractor, Hor2DFrom3DCreator, VolProc::ChainOutput, Vel::VolumeConverter, SEGY::Scanner, Seis2DLineEventSnapper, visBase::HorizonTileResolutionTesselator, HorizonSorter, Attrib::Processor, ZAxisTransformer, SeisPSMerger, Convolver3D< T >, EM::Hor2DTo3D, VolProc::ChainExecutor, LogCubeCreator, Convolver3D< float >, Seis2DTo3D, SeisDataPackWriter, Attrib::PosVecOutputGen, SeisCubeCopier, SeisMerger, Vel::FunctionAscIO, ContinuousCurvatureArray2DInterpol, BendPointFinder2DGeomSet, DPSDensityCalcND, ArrayNDGentleSmoother< T >, BodyVolumeCalculator, SeisImpCBVSFromOtherSurvey, WellTie::SeismicExtractor, DensityCalc, HorizonScanner, Strat::LayerModelGenerator, Seis2DLineMerger, StratSynthExporter, SeisRandLineTo2D, EM::HorizonZTransformer, Horizon2DScanner, Array1DInterpol, Seis2DFrom3DExtractor, SeisStatsCalc, Seis2DGridCreator, and BendPointFinderBase.

virtual void Task::setProgressMeter ( ProgressMeter *  )

inlinevirtual

Must be called before execute()

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

virtual bool Task::shouldContinue ( )

protectedvirtual

Returns

wether we should continue

static uiString Task::stdMessage ( )

inlinestatic

static uiString Task::stdNrDoneText ( )

inlinestatic

virtual int64_t Task::totalNr ( ) const

inlinevirtual

Reimplemented in Well::SimpleTrackSampler, EM::dgbSurfaceWriter, Well::LogDataExtracter, Seis::SequentialPSLoader, Well::TrackSampler, Seis::MultiTraceSynthGenerator, VelocityModelScanner, Well::InfoCollector, PreStack::EventDuplicator, DataUploader, TaskGroup, UnZipper, PreStack::EventWriter, SEGY::FileIndexer, SeisBufReader, Array2DFilterer< T >, PreStack::EventImporter, FileDownloader, EM::dgbSurfDataReader, EM::dgbSurfaceReader, DPSMerger, Zipper, ExecutorGroup, JobRunner, SEGYDirect2DLineGetter, SeisIOSimple, ParallelTask, SeisCBVS2DLineGetter, VolProc::StatsCalculatorTask, Strat::LayModAttribCalc, Seis2DCopier, TaskGroupController, visBase::HorizonTileRenderPreparer, Horizon2DGridCreator, SeisSingleTraceProc, RaySynthGenerator, LinSolverTask< T >, Seis2DLineGetter, SEGY::ReSorter, SeisImporter, PreStack::EventReader, SeisBayesClass, EM::dgbSurfDataWriter, WaveletExtractor, PreStack::EventExporter, Hor2DFrom3DCreator, VolProc::ChainOutput, PreStack::AGC, SeisPSMerger, SEGY::Scanner, EM::Hor2DTo3D, HorizonSorter, Attrib::PosVecOutputGen, LogCubeCreator, Seis2DTo3D, Attrib::Processor, Vel::FunctionAscIO, VolProc::ChainExecutor, SeisDataPackWriter, SeisImpCBVSFromOtherSurvey, SeisMerger, ContinuousCurvatureArray2DInterpol, SeisCubeCopier, BendPointFinder2DGeomSet, Seis2DLineMerger, ArrayNDGentleSmoother< T >, SeisRandLineTo2D, Strat::LayerModelGenerator, HorizonScanner, Seis2DFrom3DExtractor, SeisEventSnapper, SeisStatsCalc, StratSynthExporter, WellTie::SeismicExtractor, EM::HorizonZTransformer, and Horizon2DScanner.

static uiString Task::tr ( const char *  text, const char *  disambiguation = 0, int  pluralnr = -1  )

inlinestaticprivate

bool Task::workControlEnabled

(

)

const

Member Data Documentation

Control Task::control_

protected

Threads::ConditionVar* Task::workcontrolcondvar_

protected