VolProc::ChainOutput Class Reference

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

Inheritance diagram for VolProc::ChainOutput:

Public Member Functions
	ChainOutput ()
	~ChainOutput ()
void	controlWork (Control) override
void	enableWorkControl (bool yn=true) override
	Must be called before execute() More...
int	nextStep () override
od_int64	nrDone () const override
bool	setCalculationScope (const TrcKeySampling &, const StepInterval< int > &)
void	setChainID (const MultiID &)
void	setJobCommunicator (JobCommunic *)
void	setOutputID (const MultiID &)
void	setProgressMeter (ProgressMeter *) override
	Must be called before execute() More...
void	setTrcKeyZSampling (const TrcKeyZSampling &)
od_int64	totalNr () const override
uiString	uiMessage () const override
	will be message() again in 7.x More...
uiString	uiNrDoneText () const override
	will be nrDoneText() in 7.x More...
void	usePar (const IOPar &)
Public Member Functions inherited from Executor
	Executor (const char *nm)
virtual	~Executor ()
int	doStep () override
bool	execute () override
bool	go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
bool	go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=nullptr)
virtual	~SequentialTask ()
bool	execute () override
Public Member Functions inherited from ReportingTask
virtual	~ReportingTask ()
void	getProgress (const ReportingTask &)
Public Member Functions inherited from Task
virtual	~Task ()
virtual uiRetVal	errorWithDetails () const
virtual Control	getState () const
bool	workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
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. More...
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. More...
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

Protected Member Functions
void	createNewChainExec ()
int	getChain ()
void	manageStorers ()
bool	openOutput ()
void	reportFinished (ChainOutputStorer &)
int	retError (const uiString &)
int	retMoreToDo ()
int	setNextChunk ()
int	setupChunking ()
void	startWriteChunk ()
Protected Member Functions inherited from Executor
virtual bool	goImpl (od_ostream *, bool, bool, int)
Protected Member Functions inherited from ReportingTask
	ReportingTask (const char *nm=nullptr)
void	incrementProgress ()
ProgressMeter *	progressMeter () const
void	reportProgressFinished ()
void	reportProgressStarted ()
void	resetProgress ()
void	updateProgressMeter (bool forced=false, std::int64_t *totalnr=0)
void	updateReportedName ()
Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
Chain *	chain_
ChainExecutor *	chainexec_
MultiID	chainid_
IOPar *	chainpar_
TrcKeyZSampling	cs_
int	curexecnr_
JobCommunic *	jobcomm_
bool	neednextchunk_
int	nrexecs_
MultiID	outid_
StepInterval< int >	outputzrg_
ProgressRecorder &	progresskeeper_
bool	storererr_
Threads::Lock	storerlock_
ObjectSet< ChainOutputStorer >	storers_
TrcKeySampling	tkscalcdone_
TrcKeySampling	tkscalcscope_
ObjectSet< ChainOutputStorer >	toremstorers_
SeisDataPackWriter *	wrr_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Friends
class	ChainOutputStorer

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run , Pause , Stop }
Public Types inherited from ObjectWithName
typedef OD::String	name_type
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 ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Public Attributes inherited from Executor
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...
Notifier< Executor >	prestep
Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Detailed Description

Manages output creation for a VolProc::Chain.

<>

Constructor & Destructor Documentation

ChainOutput()

VolProc::ChainOutput::ChainOutput

(

)

~ChainOutput()

VolProc::ChainOutput::~ChainOutput

(

)

Member Function Documentation

controlWork()

void VolProc::ChainOutput::controlWork ( Control  )

overridevirtual

Reimplemented from Task.

createNewChainExec()

void VolProc::ChainOutput::createNewChainExec ( )

protected

enableWorkControl()

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

overridevirtual

Must be called before execute()

Reimplemented from Task.

getChain()

int VolProc::ChainOutput::getChain ( )

protected

manageStorers()

void VolProc::ChainOutput::manageStorers ( )

protected

nextStep()

int VolProc::ChainOutput::nextStep ( )

overridevirtual

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.

nrDone()

od_int64 VolProc::ChainOutput::nrDone ( ) const

overridevirtual

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.

openOutput()

bool VolProc::ChainOutput::openOutput ( )

protected

reportFinished()

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

protected

retError()

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

protected

retMoreToDo()

int VolProc::ChainOutput::retMoreToDo ( )

protected

setCalculationScope()

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

setChainID()

void VolProc::ChainOutput::setChainID

(

const MultiID &

)

setJobCommunicator()

void VolProc::ChainOutput::setJobCommunicator

(

JobCommunic *

)

setNextChunk()

int VolProc::ChainOutput::setNextChunk ( )

protected

setOutputID()

void VolProc::ChainOutput::setOutputID

(

const MultiID &

)

setProgressMeter()

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

overridevirtual

Must be called before execute()

Reimplemented from ReportingTask.

setTrcKeyZSampling()

void VolProc::ChainOutput::setTrcKeyZSampling

(

const TrcKeyZSampling &

)

setupChunking()

int VolProc::ChainOutput::setupChunking ( )

protected

startWriteChunk()

void VolProc::ChainOutput::startWriteChunk ( )

protected

totalNr()

od_int64 VolProc::ChainOutput::totalNr ( ) const

overridevirtual

Reimplemented from Task.

uiMessage()

uiString VolProc::ChainOutput::uiMessage ( ) const

overridevirtual

will be message() again in 7.x

Reimplemented from Task.

uiNrDoneText()

uiString VolProc::ChainOutput::uiNrDoneText ( ) const

overridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

usePar()

void VolProc::ChainOutput::usePar

(

const IOPar &

)

Friends And Related Function Documentation

ChainOutputStorer

friend class ChainOutputStorer

friend

Member Data Documentation

chain_

Chain* VolProc::ChainOutput::chain_

protected

chainexec_

ChainExecutor* VolProc::ChainOutput::chainexec_

protected

chainid_

MultiID VolProc::ChainOutput::chainid_

protected

chainpar_

IOPar* VolProc::ChainOutput::chainpar_

protected

cs_

TrcKeyZSampling VolProc::ChainOutput::cs_

protected

curexecnr_

int VolProc::ChainOutput::curexecnr_

protected

jobcomm_

JobCommunic* VolProc::ChainOutput::jobcomm_

protected

neednextchunk_

bool VolProc::ChainOutput::neednextchunk_

protected

nrexecs_

int VolProc::ChainOutput::nrexecs_

protected

outid_

MultiID VolProc::ChainOutput::outid_

protected

outputzrg_

StepInterval<int> VolProc::ChainOutput::outputzrg_

protected

progresskeeper_

ProgressRecorder& VolProc::ChainOutput::progresskeeper_

protected

storererr_

bool VolProc::ChainOutput::storererr_

protected

storerlock_

Threads::Lock VolProc::ChainOutput::storerlock_

mutableprotected

storers_

ObjectSet<ChainOutputStorer> VolProc::ChainOutput::storers_

protected

tkscalcdone_

TrcKeySampling VolProc::ChainOutput::tkscalcdone_

protected

tkscalcscope_

TrcKeySampling VolProc::ChainOutput::tkscalcscope_

protected

toremstorers_

ObjectSet<ChainOutputStorer> VolProc::ChainOutput::toremstorers_

protected

wrr_

SeisDataPackWriter* VolProc::ChainOutput::wrr_

protected