VolProc::ChainOutput Class Reference

Manages output creation for a VolProc::Chain. More...

Inheritance diagram for VolProc::ChainOutput:

Public Member Functions
	ChainOutput ()
	~ChainOutput ()
void	setChainID (const MultiID &)
void	setOutputID (const MultiID &)
void	setTrcKeyZSampling (const TrcKeyZSampling &)
bool	setCalculationScope (const TrcKeySampling &, const StepInterval< int > &)
void	usePar (const IOPar &)
virtual od_int64	nrDone () const
virtual od_int64	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 int	nextStep ()
virtual void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool yn=true)
	Must be called before execute() More...
void	setJobCommunicator (JobCommunic *)
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 ()
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
bool	execute ()
Public Member Functions inherited from Task
virtual	~Task ()
bool	workControlEnabled () const
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...

Protected Member Functions
int	getChain ()
int	setupChunking ()
int	setNextChunk ()
bool	openOutput ()
void	createNewChainExec ()
int	retError (const uiString &)
int	retMoreToDo ()
void	startWriteChunk ()
void	manageStorers ()
void	reportFinished (ChainOutputStorer &)
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 CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Protected Attributes
MultiID	chainid_
MultiID	outid_
TrcKeyZSampling	cs_
IOPar *	chainpar_
Chain *	chain_
ChainExecutor *	chainexec_
SeisDataPackWriter *	wrr_
bool	neednextchunk_
int	nrexecs_
int	curexecnr_
StepInterval< int >	outputzrg_
ProgressRecorder &	progresskeeper_
Threads::Lock	storerlock_
ObjectSet< ChainOutputStorer >	storers_
ObjectSet< ChainOutputStorer >	toremstorers_
bool	storererr_
JobCommunic *	jobcomm_
Protected Attributes inherited from SequentialTask
ProgressMeter *	progressmeter_
int	lastupdate_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

Private Member Functions
	mODTextTranslationClass (ChainOutput)

Friends
class	ChainOutputStorer

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
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	stdNrDoneText ()
static uiString	uiStdNrDoneText ()
Public Attributes inherited from Executor
Notifier< Executor >	prestep
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...

Detailed Description

Manages output creation for a VolProc::Chain.

Constructor & Destructor Documentation

VolProc::ChainOutput::ChainOutput

(

)

VolProc::ChainOutput::~ChainOutput

(

)

Member Function Documentation

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

virtual

Reimplemented from Task.

void VolProc::ChainOutput::createNewChainExec ( )

protected

virtual void VolProc::ChainOutput::enableWorkControl ( bool  = true )

virtual

Must be called before execute()

Reimplemented from Task.

int VolProc::ChainOutput::getChain ( )

protected

void VolProc::ChainOutput::manageStorers ( )

protected

VolProc::ChainOutput::mODTextTranslationClass ( ChainOutput  )

private

virtual int VolProc::ChainOutput::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::ChainOutput::nrDone ( ) const

virtual

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 from Task.

bool VolProc::ChainOutput::openOutput ( )

protected

void VolProc::ChainOutput::reportFinished ( ChainOutputStorer &  )

protected

int VolProc::ChainOutput::retError ( const uiString &  )

protected

int VolProc::ChainOutput::retMoreToDo ( )

protected

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

void VolProc::ChainOutput::setChainID

(

const MultiID &

)

void VolProc::ChainOutput::setJobCommunicator

(

JobCommunic *

)

int VolProc::ChainOutput::setNextChunk ( )

protected

void VolProc::ChainOutput::setOutputID

(

const MultiID &

)

virtual void VolProc::ChainOutput::setProgressMeter ( ProgressMeter *  )

virtual

Must be called before execute()

Reimplemented from SequentialTask.

void VolProc::ChainOutput::setTrcKeyZSampling

(

const TrcKeyZSampling &

)

int VolProc::ChainOutput::setupChunking ( )

protected

void VolProc::ChainOutput::startWriteChunk ( )

protected

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

virtual

Reimplemented from Task.

virtual uiString VolProc::ChainOutput::uiMessage ( ) const

virtual

will be message() again in 7.x

Note

totalNr is only used for displaying progress.

Reimplemented from Task.

virtual uiString VolProc::ChainOutput::uiNrDoneText ( ) const

virtual

will be nrDoneText() in 7.x

Reimplemented from Task.

void VolProc::ChainOutput::usePar

(

const IOPar &

)

Friends And Related Function Documentation

friend class ChainOutputStorer

friend

Member Data Documentation

Chain* VolProc::ChainOutput::chain_

protected

ChainExecutor* VolProc::ChainOutput::chainexec_

protected

MultiID VolProc::ChainOutput::chainid_

protected

IOPar* VolProc::ChainOutput::chainpar_

protected

TrcKeyZSampling VolProc::ChainOutput::cs_

protected

int VolProc::ChainOutput::curexecnr_

protected

JobCommunic* VolProc::ChainOutput::jobcomm_

protected

bool VolProc::ChainOutput::neednextchunk_

protected

int VolProc::ChainOutput::nrexecs_

protected

MultiID VolProc::ChainOutput::outid_

protected

StepInterval<int> VolProc::ChainOutput::outputzrg_

protected

ProgressRecorder& VolProc::ChainOutput::progresskeeper_

protected

bool VolProc::ChainOutput::storererr_

protected

Threads::Lock VolProc::ChainOutput::storerlock_

mutableprotected

ObjectSet<ChainOutputStorer> VolProc::ChainOutput::storers_

protected

ObjectSet<ChainOutputStorer> VolProc::ChainOutput::toremstorers_

protected

SeisDataPackWriter* VolProc::ChainOutput::wrr_

protected