SEGY::FileIndexer Class Reference

Inheritance diagram for SEGY::FileIndexer:

Public Member Functions
	FileIndexer (const MultiID &mid, bool isvol, const FileSpec &, bool is2d, const IOPar &)
	~FileIndexer ()
int	nextStep ()
od_int64	nrDone () const
Scanner *	scanner ()
const Scanner *	scanner () const
od_int64	totalNr () const
uiString	uiMessage () const
	will be message() again in 7.x More...
uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...
Public Member Functions inherited from Executor
	Executor (const char *nm)
virtual	~Executor ()
virtual int	doStep ()
virtual bool	execute ()
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 ()
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
Public Member Functions inherited from Task
virtual	~Task ()
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
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
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 &)
virtual const name_type &	name () const
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 Attributes
DirectDef *	directdef_
Pos::GeomID	geomid_
IOObj *	ioobj_
bool	is2d_
bool	isvol_
uiString	msg_
Scanner *	scanner_
Protected Attributes inherited from SequentialTask
int	lastupdate_
ProgressMeter *	progressmeter_
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_

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
Protected Member Functions inherited from Executor
virtual bool	goImpl (od_ostream *, bool, bool, int)
Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Detailed Description

Scans a file and creates an index file that can be read by OD.

<>

Constructor & Destructor Documentation

FileIndexer()

SEGY::FileIndexer::FileIndexer	(	const MultiID &	mid,
		bool	isvol,
		const FileSpec &	,
		bool	is2d,
		const IOPar &
	)

~FileIndexer()

SEGY::FileIndexer::~FileIndexer

(

)

Member Function Documentation

nextStep()

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

nrDone()

od_int64 SEGY::FileIndexer::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.

scanner() [1/2]

Scanner* SEGY::FileIndexer::scanner ( )

inline

scanner() [2/2]

const Scanner* SEGY::FileIndexer::scanner ( ) const

inline

totalNr()

od_int64 SEGY::FileIndexer::totalNr ( ) const

virtual

Reimplemented from Task.

uiMessage()

uiString SEGY::FileIndexer::uiMessage ( ) const

virtual

will be message() again in 7.x

Reimplemented from Task.

uiNrDoneText()

uiString SEGY::FileIndexer::uiNrDoneText ( ) const

virtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

directdef_

DirectDef* SEGY::FileIndexer::directdef_

protected

geomid_

Pos::GeomID SEGY::FileIndexer::geomid_

protected

ioobj_

IOObj* SEGY::FileIndexer::ioobj_

protected

is2d_

bool SEGY::FileIndexer::is2d_

protected

isvol_

bool SEGY::FileIndexer::isvol_

protected

msg_

uiString SEGY::FileIndexer::msg_

mutableprotected

scanner_

Scanner* SEGY::FileIndexer::scanner_

protected