IOObj Class Reference

Inheritance diagram for IOObj:

Public Member Functions
uiString	uiName () const
IOObj *	clone () const
virtual const MultiID &	key () const
virtual	~IOObj ()
virtual bool	isBad () const =0
virtual void	copyFrom (const IOObj *)=0
virtual bool	hasConnType (const char *s) const
virtual const char *	connType () const =0
virtual Conn *	getConn (bool forread) const =0
virtual const OD::String &	translator () const
virtual void	setTranslator (const char *s)
virtual const OD::String &	group () const
virtual void	setGroup (const char *s)
virtual const char *	fullUserExpr (bool forread=true) const =0
virtual BufferString	mainFileName () const
virtual bool	implExists (bool forread) const =0
virtual bool	implReadOnly () const
virtual bool	implRemove () const
virtual bool	implManagesObjects () const
virtual bool	implRename (const char *, const CallBack *cb=0)
virtual bool	implSetReadOnly (bool) const
virtual const char *	dirName () const
	The directory ame within the tree. More...
virtual IOPar &	pars () const
void	updateCreationPars () const
void	setSurveyDefault (const char *subsel=0) const
Translator *	createTranslator () const
void	acquireNewKeyIn (const MultiID &)
	This will give the IOObj a new (free) ID. More...
bool	isTmp () const
bool	isProcTmp () const
bool	isUserSelectable (bool forread=true) const
bool	isInCurrentSurvey () const
void	setKey (const char *nm)
virtual void	setDirName (const char *s)
virtual bool	isSubdir () 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...

Static Public Member Functions
static bool	isKey (const char *)
static bool	isSurveyDefault (const MultiID &)
	Checks the 'Default.' entries in SI().pars() More...
static int	tmpID ()
static int	addProducer (IOObjProducer *)
	Factory for IOObj types. Not for casual use. More...

Protected Member Functions
	IOObj (const char *nm=0, const char *ky=0)
	IOObj (const IOObj &)
bool	put (ascostream &) const
virtual bool	getFrom (ascistream &)=0
virtual bool	putTo (ascostream &) const =0
int	myKey () const
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Static Protected Member Functions
static IOObj *	get (ascistream &, const char *, const char *)

Protected Attributes
BufferString	dirnm_
MultiID	key_
BufferString	transl_
BufferString	group_
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

Private Member Functions
void	copyStuffFrom (const IOObj &)

Static Private Member Functions
static IOObj *	produce (const char *, const char *nm=0, const char *ky=0, bool initdefaults=true)

Private Attributes
IOPar &	pars_

Friends
class	IODir

Detailed Description

Constructor & Destructor Documentation

virtual IOObj::~IOObj ( )

virtual

IOObj::IOObj ( const char *  nm = 0, const char *  ky = 0  )

protected

IOObj::IOObj ( const IOObj &  )

protected

Member Function Documentation

void IOObj::acquireNewKeyIn

(

const MultiID &

)

This will give the IOObj a new (free) ID.

static int IOObj::addProducer ( IOObjProducer *  )

static

Factory for IOObj types. Not for casual use.

IOObj* IOObj::clone

(

)

const

virtual const char* IOObj::connType ( ) const

pure virtual

Implemented in IOStream, IOSubDir, and IOX.

virtual void IOObj::copyFrom ( const IOObj *  )

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

void IOObj::copyStuffFrom ( const IOObj &  )

private

Translator* IOObj::createTranslator

(

)

const

returns a subclass of Translator according to the translator name and group.

virtual const char* IOObj::dirName ( ) const

inlinevirtual

The directory ame within the tree.

Reimplemented in IOSubDir, and IOX.

virtual const char* IOObj::fullUserExpr ( bool  forread = true ) const

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

static IOObj* IOObj::get ( ascistream &  , const char *  , const char *    )

staticprotected

virtual Conn* IOObj::getConn ( bool  forread ) const

pure virtual

Implemented in IOStream, IOSubDir, and IOX.

virtual bool IOObj::getFrom ( ascistream &  )

protectedpure virtual

Implemented in IOStream, IOX, and IOSubDir.

virtual const OD::String& IOObj::group ( ) const

inlinevirtual

virtual bool IOObj::hasConnType ( const char *  s ) const

inlinevirtual

virtual bool IOObj::implExists ( bool  forread ) const

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

virtual bool IOObj::implManagesObjects ( ) const

inlinevirtual

Reimplemented in IOStream, IOX, and IOSubDir.

virtual bool IOObj::implReadOnly ( ) const

inlinevirtual

Reimplemented in IOStream, and IOSubDir.

virtual bool IOObj::implRemove ( ) const

inlinevirtual

Reimplemented in IOStream, and IOSubDir.

virtual bool IOObj::implRename ( const char *  , const CallBack *  cb = 0  )

inlinevirtual

Reimplemented in IOStream, and IOSubDir.

virtual bool IOObj::implSetReadOnly ( bool  ) const

inlinevirtual

Reimplemented in IOStream, and IOSubDir.

virtual bool IOObj::isBad ( ) const

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

bool IOObj::isInCurrentSurvey

(

)

const

static bool IOObj::isKey ( const char *  )

static

Returns whether given string may be a valid key

bool IOObj::isProcTmp

(

)

const

virtual bool IOObj::isSubdir ( ) const

inlinevirtual

Reimplemented in IOSubDir.

static bool IOObj::isSurveyDefault ( const MultiID &  )

static

Checks the 'Default.' entries in SI().pars()

bool IOObj::isTmp ( ) const

inline

bool IOObj::isUserSelectable

(

bool

forread = true

)

const

virtual const MultiID& IOObj::key ( ) const

inlinevirtual

virtual BufferString IOObj::mainFileName ( ) const

inlinevirtual

Reimplemented in IOStream.

int IOObj::myKey ( ) const

protected

virtual IOPar& IOObj::pars ( ) const

inlinevirtual

These are the extra parameters: #xxx: yyy in .omf

static IOObj* IOObj::produce ( const char *  , const char *  nm = 0, const char *  ky = 0, bool  initdefaults = true  )

staticprivate

bool IOObj::put ( ascostream &  ) const

protected

virtual bool IOObj::putTo ( ascostream &  ) const

protectedpure virtual

Implemented in IOStream, IOX, and IOSubDir.

virtual void IOObj::setDirName ( const char *  s )

inlinevirtual

Reimplemented in IOStream.

virtual void IOObj::setGroup ( const char *  s )

inlinevirtual

void IOObj::setKey ( const char *  nm )

inline

void IOObj::setSurveyDefault

(

const char *

subsel = 0

)

const

Parameters

subsel

may be a subselection lower than the translator group, such as "Velocity".

virtual void IOObj::setTranslator ( const char *  s )

inlinevirtual

static int IOObj::tmpID ( )

inlinestatic

virtual const OD::String& IOObj::translator ( ) const

inlinevirtual

uiString IOObj::uiName ( ) const

inline

void IOObj::updateCreationPars

(

)

const

Friends And Related Function Documentation

friend class IODir

friend

Member Data Documentation

BufferString IOObj::dirnm_

protected

BufferString IOObj::group_

protected

MultiID IOObj::key_

protected

IOPar& IOObj::pars_

private

BufferString IOObj::transl_

protected