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 ()
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 Scanner *	scanner () 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...

Protected Attributes
IOObj *	ioobj_
Pos::GeomID	geomid_
Scanner *	scanner_
uiString	msg_
DirectDef *	directdef_
bool	is2d_
bool	isvol_
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 (FileIndexer)

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

Detailed Description

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

Constructor & Destructor Documentation

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

SEGY::FileIndexer::~FileIndexer

(

)

Member Function Documentation

SEGY::FileIndexer::mODTextTranslationClass ( FileIndexer  )

private

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.

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.

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

inline

od_int64 SEGY::FileIndexer::totalNr ( ) const

virtual

Reimplemented from Task.

uiString SEGY::FileIndexer::uiMessage ( ) const

virtual

will be message() again in 7.x

Note

totalNr is only used for displaying progress.

Reimplemented from Task.

uiString SEGY::FileIndexer::uiNrDoneText ( ) const

virtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

DirectDef* SEGY::FileIndexer::directdef_

protected

Pos::GeomID SEGY::FileIndexer::geomid_

protected

IOObj* SEGY::FileIndexer::ioobj_

protected

bool SEGY::FileIndexer::is2d_

protected

bool SEGY::FileIndexer::isvol_

protected

uiString SEGY::FileIndexer::msg_

mutableprotected

Scanner* SEGY::FileIndexer::scanner_

protected