SEGY::Scanner Class Reference

Scans SEG-Y file(s). For reports, you'd want to set rich info. More...

Inheritance diagram for SEGY::Scanner:

Public Member Functions
	Scanner (const IOPar &, Seis::GeomType)
	Scanner (const FileSpec &, Seis::GeomType, const IOPar &)
	~Scanner ()
Seis::GeomType	geomType () const
const IOPar &	pars () const
void	setMaxNrtraces (int n)
void	setForceRev0 (bool yn)
void	setRichInfo (bool yn)
void	collectInfoPerTrace (bool yn)
int	nextStep ()
uiString	uiMessage () const
	will be message() again in 7.x More...
od_int64	nrDone () const
od_int64	totalNr () const
uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...
const FileDataSet &	fileDataSet () const
FileDataSet &	fileDataSet ()
void	getReport (IOPar &, const IOPar *inppars=0) const
StepInterval< float >	zRange () const
const PosInfo::Detector &	posInfoDetector () const
const BufferStringSet &	warnings () const
const SEGYSeisTrcTranslator *	translator () const
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 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...

Public Attributes
BufferStringSet	fnms_
	Actually used, possibly with errs. More...
BufferStringSet	failedfnms_
	Failed to open or read. More...
uiStringSet	failerrmsgs_
	Err Msgs for failed. More...
BufferStringSet	scanerrfnms_
	Error during scan (but in fnms_) More...
uiStringSet	scanerrmsgs_
	Err Msgs for 'Error during scan'. More...
Public Attributes inherited from Executor
Notifier< Executor >	prestep
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...

Protected Member Functions
int	openNext ()
int	readNext ()
void	closeTr ()
void	init (const FileSpec &)
int	finish (bool)
void	addFailed (const uiString &)
void	initFileData ()
void	addErrReport (IOPar &) const
uiString	Openff ()
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
Seis::GeomType	geom_
const IOPar &	pars_
FileDataSet &	fds_
SEGYSeisTrcTranslator *	tr_
DataClipSampler &	clipsmplr_
int	nrtrcs_
bool	forcerev0_
bool	richinfo_
SeisTrc &	trc_
int	curfidx_
uiString	msg_
od_int64	nrdone_
od_int64	totnr_
PosInfo::Detector &	dtctor_
BufferStringSet	trwarns_
bool	notrcinfo_
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 (Scanner)

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

Detailed Description

Scans SEG-Y file(s). For reports, you'd want to set rich info.

Constructor & Destructor Documentation

SEGY::Scanner::Scanner	(	const IOPar &	,
		Seis::GeomType
	)

SEGY::Scanner::Scanner	(	const FileSpec &	,
		Seis::GeomType	,
		const IOPar &
	)

SEGY::Scanner::~Scanner

(

)

Member Function Documentation

void SEGY::Scanner::addErrReport ( IOPar &  ) const

protected

void SEGY::Scanner::addFailed ( const uiString &  )

protected

void SEGY::Scanner::closeTr ( )

protected

void SEGY::Scanner::collectInfoPerTrace ( bool  yn )

inline

const FileDataSet& SEGY::Scanner::fileDataSet ( ) const

inline

FileDataSet& SEGY::Scanner::fileDataSet ( )

inline

int SEGY::Scanner::finish ( bool  )

protected

Seis::GeomType SEGY::Scanner::geomType ( ) const

inline

void SEGY::Scanner::getReport	(	IOPar &	,
		const IOPar *	inppars = 0
	)		const

void SEGY::Scanner::init ( const FileSpec &  )

protected

void SEGY::Scanner::initFileData ( )

protected

SEGY::Scanner::mODTextTranslationClass ( Scanner  )

private

int SEGY::Scanner::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.

od_int64 SEGY::Scanner::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 from Task.

uiString SEGY::Scanner::Openff ( )

inlineprotected

int SEGY::Scanner::openNext ( )

protected

const IOPar& SEGY::Scanner::pars ( ) const

inline

const PosInfo::Detector& SEGY::Scanner::posInfoDetector ( ) const

inline

int SEGY::Scanner::readNext ( )

protected

void SEGY::Scanner::setForceRev0 ( bool  yn )

inline

void SEGY::Scanner::setMaxNrtraces ( int  n )

inline

void SEGY::Scanner::setRichInfo ( bool  yn )

inline

od_int64 SEGY::Scanner::totalNr ( ) const

virtual

Reimplemented from Task.

const SEGYSeisTrcTranslator* SEGY::Scanner::translator ( ) const

inline

uiString SEGY::Scanner::uiMessage ( ) const

inlinevirtual

will be message() again in 7.x

Note

totalNr is only used for displaying progress.

Reimplemented from Task.

uiString SEGY::Scanner::uiNrDoneText ( ) const

inlinevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

const BufferStringSet& SEGY::Scanner::warnings ( ) const

inline

StepInterval<float> SEGY::Scanner::zRange

(

)

const

Member Data Documentation

DataClipSampler& SEGY::Scanner::clipsmplr_

protected

int SEGY::Scanner::curfidx_

protected

PosInfo::Detector& SEGY::Scanner::dtctor_

protected

BufferStringSet SEGY::Scanner::failedfnms_

Failed to open or read.

uiStringSet SEGY::Scanner::failerrmsgs_

Err Msgs for failed.

FileDataSet& SEGY::Scanner::fds_

protected

BufferStringSet SEGY::Scanner::fnms_

Actually used, possibly with errs.

bool SEGY::Scanner::forcerev0_

protected

Seis::GeomType SEGY::Scanner::geom_

protected

uiString SEGY::Scanner::msg_

protected

bool SEGY::Scanner::notrcinfo_

protected

od_int64 SEGY::Scanner::nrdone_

protected

int SEGY::Scanner::nrtrcs_

protected

const IOPar& SEGY::Scanner::pars_

protected

bool SEGY::Scanner::richinfo_

protected

BufferStringSet SEGY::Scanner::scanerrfnms_

Error during scan (but in fnms_)

uiStringSet SEGY::Scanner::scanerrmsgs_

Err Msgs for 'Error during scan'.

od_int64 SEGY::Scanner::totnr_

mutableprotected

SEGYSeisTrcTranslator* SEGY::Scanner::tr_

protected

SeisTrc& SEGY::Scanner::trc_

protected

BufferStringSet SEGY::Scanner::trwarns_

protected