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 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...
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 NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject *linkedto)
	NamedObject (const NamedObject &)
virtual	~NamedObject ()
void	setLinkedTo (NamedObject *)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual const OD::String &	annotName () const
virtual void	setName (const char *)
void	setCleanName (const char *)
	cleans string first More...
void	deleteNotify (const CallBack &)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
bool	attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
void	detachCB (NotifierAccess &, const CallBack &)
void	detachCB (NotifierAccess *notif, const CallBack &cb)
bool	isNotifierAttached (NotifierAccess *) const
	Only for debugging purposes, don't use. More...

Static Public Member Functions
static uiString	stdNrDoneText ()
static uiString	uiStdNrDoneText ()

Protected Member Functions
	Task (const char *nm=0)
virtual bool	shouldContinue ()
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Protected Attributes
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

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

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 TaskGroup, VolProc::ChainExecutor, VolProc::ChainOutput, Smoother2D< T >, Smoother3D< T >, and Smoother3D< float >.

virtual void Task::enableWorkControl ( bool  = true )

virtual

Must be called before execute()

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

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 TaskGroup, Smoother2D< T >, Smoother3D< T >, and Smoother3D< float >.

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

inlinestaticprivate

virtual const char* Task::message ( ) const

inlineprivatevirtual

Reimplemented in Geometry::ArrayTesselator, and Seis2DTo3DInterPol.

virtual int64_t 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 Well::SimpleTrackSampler, EM::dgbSurfaceWriter, Well::LogDataExtracter, Seis::RaySynthGenerator, Well::TrackSampler, Seis::SequentialReader, MarchingCubes2Implicit, Well::InfoCollector, VelocityModelScanner, DataUploader, PreStack::EventDuplicator, ParallelSorter< T >, UnZipper, SEGY::FileIndexer, Seis2DTo3D, SeisBufReader, PreStack::EventImporter, Array2DFilterer< T >, EM::dgbSurfDataReader, FileDownloader, EM::dgbSurfaceReader, SeisIOSimple, Table::Converter, TaskGroup, Zipper, DPSMerger, JobRunner, ExecutorGroup, SEGYDirect2DLineGetter, SeisCBVS2DLineGetter, ParallelTask, Seis2DCopier, Strat::LayModAttribCalc, Horizon2DGridCreator, Geometry::BulkFaultBinIDSurfaceIntersector, SeisImpBPSIF, SeisSingleTraceProc, LinSolverTask< T >, Seis2DLineGetter, SEGY::ReSorter, SeisImporter, VolProc::ChainExecutor, SeisBayesClass, WaveletExtractor, EM::dgbSurfDataWriter, PreStack::EventExporter, Hor2DFrom3DCreator, SeisPSMerger, VolProc::ChainOutput, SEGY::Scanner, HorizonSorter, SeisInterpol, EM::Hor2DTo3D, Attrib::Processor, Attrib::PosVecOutputGen, SeisCubeCopier, SeisDataPackWriter, Seis2DTo3DInterPol, SeisRandLineTo2D, SeisScanner, Vel::FunctionAscIO, Seis2DLineMerger, SeisImpCBVSFromOtherSurvey, ArrayNDGentleSmoother< T >, DPSDensityCalcND, BendPointFinder2DGeomSet, HorizonScanner, SeisEventSnapper, SeisMerger, DensityCalc, RayTracerRunner, WellTie::SeismicExtractor, Strat::LayerModelGenerator, Seis2DFrom3DExtractor, Array1DInterpol, EM::HorizonZTransformer, StratSynthExporter, and Horizon2DScanner.

virtual const char* Task::nrDoneText ( ) const

inlineprivatevirtual

Reimplemented in Seis2DTo3DInterPol.

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

inlinestatic

virtual int64_t Task::totalNr ( ) const

inlinevirtual

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

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

inlinestaticprivate

virtual uiString Task::uiMessage ( ) const

virtual

will be message() again in 7.x

Note

totalNr is only used for displaying progress.

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

virtual uiString Task::uiNrDoneText ( ) const

virtual

will be nrDoneText() in 7.x

Reimplemented in MuteArrayExtracter< T >, Array3DUdfTrcRestorer< T >, ArrayUdfValRestorer< T >, ArrayUdfValReplacer< T >, ArrayMath::CumSumExec< T >, ArrayMath::ArrOperExec< OperType, ArrType >, ArrayMath::CumArrOperExec< RT, AT >, Array3DCopier< T >, Array2DCopier< T >, Well::SimpleTrackSampler, EM::dgbSurfaceWriter, DPSFromVolumeFiller, Well::LogDataExtracter, Seis::RaySynthGenerator, Well::TrackSampler, Seis::SequentialReader, TriangulationArray2DInterpol, DelaunayTriangulator, VelocityModelScanner, Well::InfoCollector, ColTab::MapperTask< T >, MemValReplacer< T >, DataUploader, PreStack::EventDuplicator, Seis::ParallelReader2D, Line2DInterSectionFinder, visBase::HorizonSectionTilePosSetup, UnZipper, SEGY::FileIndexer, PreStack::EventImporter, Seis2DTo3D, SeisBufReader, EM::dgbSurfDataReader, Array2DFilterer< T >, MemCopier< T >, FileDownloader, EM::dgbSurfaceReader, SeisIOSimple, TaskGroup, Table::Converter, Zipper, DPSMerger, ExecutorGroup, InverseDistanceArray2DInterpol, Seis2DCopier, visBase::HorizonTileRenderPreparer, Strat::LayModAttribCalc, Geometry::BulkFaultBinIDSurfaceIntersector, Array2DReSampler< T, TT >, Horizon2DGridCreator, Seis::ParallelReader, SeisImpBPSIF, SeisSingleTraceProc, SEGY::ReSorter, Seis2DLineGetter, LinSolverTask< T >, ZAxisTransformer, SeisImporter, PreStack::EventExporter, MemSetter< T >, SeisBayesClass, EM::dgbSurfDataWriter, WaveletExtractor, Vel::VolumeConverter, VolProc::ChainExecutor, VolProc::ChainOutput, SEGY::Scanner, visBase::HorizonTileResolutionTesselator, HorizonSorter, SeisInterpol, Attrib::Processor, SeisPSMerger, Convolver3D< T >, EM::Hor2DTo3D, Convolver3D< float >, SeisDataPackWriter, Array1DInterpol, SeisCubeCopier, Attrib::PosVecOutputGen, LogCubeCreator, SeisScanner, Vel::FunctionAscIO, BendPointFinder2DGeomSet, SeisImpCBVSFromOtherSurvey, ArrayNDGentleSmoother< T >, ContinuousCurvatureArray2DInterpol, SeisMerger, DPSDensityCalcND, HorizonScanner, SeisRandLineTo2D, WellTie::SeismicExtractor, DensityCalc, Strat::LayerModelGenerator, Seis2DLineMerger, StratSynthExporter, EM::HorizonZTransformer, Horizon2DScanner, Seis2DFrom3DExtractor, Seis2DGridCreator, and BendPointFinderBase.

static uiString Task::uiStdNrDoneText ( )

inlinestatic

bool Task::workControlEnabled

(

)

const

Member Data Documentation

Control Task::control_

protected

Threads::ConditionVar* Task::workcontrolcondvar_

protected