VolProc::ChainExecutor Class Reference

executes the work for a single VolProc::Chain. More...

Inheritance diagram for VolProc::ChainExecutor:

Classes
class	Epoch

Public Member Functions
	ChainExecutor (Chain &)
	~ChainExecutor ()
bool	setCalculationScope (const TrcKeySampling &, const StepInterval< int > &)
od_int64	computeMaximumMemoryUsage (const TrcKeySampling &, const StepInterval< int > &)
bool	areSamplesIndependent () const
bool	needsFullVolume () const
const RegularSeisDataPack *	getOutput () const
RegularSeisDataPack *	getOutput ()
uiString	errMsg () const
virtual int	nextStep ()
virtual od_int64	nrDone () const
virtual od_int64	totalNr () const
virtual uiString	message () const
virtual uiString	nrDoneText () const
virtual void	controlWork (Control)
Public Member Functions inherited from Executor
	Executor (const char *nm)
virtual	~Executor ()
virtual int	doStep ()
bool	go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
bool	go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
virtual bool	execute ()
Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=0)
virtual	~SequentialTask ()
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
bool	execute ()
Public Member Functions inherited from Task
virtual	~Task ()
virtual uiRetVal	errorWithDetails () const
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
bool	workControlEnabled () const
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	sGetStepErrMsg ()
Static Public Member Functions inherited from SequentialTask
static int	ErrorOccurred ()
static int	Finished ()
static int	MoreToDo ()
static int	WarningAvailable ()
Static Public Member Functions inherited from Task
static uiString	stdMessage ()
static uiString	stdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Private Member Functions
	mODTextTranslationClass (ChainExecutor)
bool	scheduleWork ()
void	releaseMemory ()
int	computeLatestEpoch (Step::ID) const
void	computeComputationScope (Step::ID stepid, TrcKeySampling &stepoutputhrg, StepInterval< int > &stepoutputzrg) const
Step::ID	getChainOutputStepID () const
Step::OutputSlotID	getChainOutputSlotID () const

Private Attributes
Epoch *	curepoch_
bool	isok_
Chain &	chain_
TrcKeySampling	outputhrg_
StepInterval< int >	outputzrg_
uiString	errmsg_
ObjectSet< Step >	scheduledsteps_
ObjectSet< Epoch >	epochs_
Chain::Web	web_
int	totalnrepochs_
RefMan< RegularSeisDataPack >	outputdp_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
Public Attributes inherited from Executor
Notifier< Executor >	prestep
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...
Protected Member Functions inherited from Executor
virtual bool	goImpl (od_ostream *, bool, bool, int)
Protected Member Functions inherited from Task
	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 inherited from SequentialTask
ProgressMeter *	progressmeter_
int	lastupdate_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Notifier< NamedCallBacker >	delnotif_
Threads::Atomic< bool >	delalreadytriggered_
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

executes the work for a single VolProc::Chain.

Constructor & Destructor Documentation

VolProc::ChainExecutor::ChainExecutor

(

Chain &

)

VolProc::ChainExecutor::~ChainExecutor

(

)

Member Function Documentation

bool VolProc::ChainExecutor::areSamplesIndependent

(

)

const

void VolProc::ChainExecutor::computeComputationScope ( Step::ID  stepid, TrcKeySampling &  stepoutputhrg, StepInterval< int > &  stepoutputzrg  ) const

private

int VolProc::ChainExecutor::computeLatestEpoch ( Step::ID  ) const

private

od_int64 VolProc::ChainExecutor::computeMaximumMemoryUsage	(	const TrcKeySampling &	,
		const StepInterval< int > &
	)

virtual void VolProc::ChainExecutor::controlWork ( Control  )

virtual

Reimplemented from Task.

uiString VolProc::ChainExecutor::errMsg

(

)

const

Step::OutputSlotID VolProc::ChainExecutor::getChainOutputSlotID ( ) const

private

Step::ID VolProc::ChainExecutor::getChainOutputStepID ( ) const

private

const RegularSeisDataPack* VolProc::ChainExecutor::getOutput

(

)

const

RegularSeisDataPack* VolProc::ChainExecutor::getOutput

(

)

virtual uiString VolProc::ChainExecutor::message ( ) const

virtual

Implements Executor.

VolProc::ChainExecutor::mODTextTranslationClass ( ChainExecutor  )

private

bool VolProc::ChainExecutor::needsFullVolume

(

)

const

virtual int VolProc::ChainExecutor::nextStep ( )

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

Implements SequentialTask.

virtual od_int64 VolProc::ChainExecutor::nrDone ( ) const

virtual

Note

only used for displaying progress.

Implements Executor.

virtual uiString VolProc::ChainExecutor::nrDoneText ( ) const

virtual

Implements Executor.

void VolProc::ChainExecutor::releaseMemory ( )

private

bool VolProc::ChainExecutor::scheduleWork ( )

private

bool VolProc::ChainExecutor::setCalculationScope	(	const TrcKeySampling &	,
		const StepInterval< int > &
	)

static uiString VolProc::ChainExecutor::sGetStepErrMsg ( )

static

virtual od_int64 VolProc::ChainExecutor::totalNr ( ) const

virtual

Reimplemented from Task.

Member Data Documentation

Chain& VolProc::ChainExecutor::chain_

private

Epoch* VolProc::ChainExecutor::curepoch_

private

ObjectSet<Epoch> VolProc::ChainExecutor::epochs_

private

uiString VolProc::ChainExecutor::errmsg_

mutableprivate

bool VolProc::ChainExecutor::isok_

private

RefMan<RegularSeisDataPack> VolProc::ChainExecutor::outputdp_

private

TrcKeySampling VolProc::ChainExecutor::outputhrg_

private

StepInterval<int> VolProc::ChainExecutor::outputzrg_

private

ObjectSet<Step> VolProc::ChainExecutor::scheduledsteps_

private

int VolProc::ChainExecutor::totalnrepochs_

private

Chain::Web VolProc::ChainExecutor::web_

private