IOObj Class Reference

Inheritance diagram for IOObj:

Public Types
typedef DBKey::ObjID	ObjID
typedef DBKey::ObjNrType	ObjNrType
typedef DBKey::GroupID	DirID

Public Member Functions
uiString	uiName () const
IOObj *	clone () const
virtual DBKey	key () const
virtual ObjID	objID () const
virtual	~IOObj ()
virtual bool	isBad () const =0
virtual void	copyFrom (const IOObj &)
virtual bool	hasConnType (const char *s) const
virtual const char *	connType () const =0
virtual bool	isStream () const
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	setKeyForNewEntry (DirID)
	This will mark the IOObj for DBM() as 'new'. More...
bool	isTmp () const
bool	isProcTmp () const
bool	isUserSelectable (bool forread=true) const
bool	isInCurrentSurvey () const
bool	isInvalid () const
void	setKey (const DBKey &ky)
virtual void	setDirName (const char *s)
virtual bool	isSubdir () const
virtual void	setAbsDirectory (const char *)
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual BufferString	getName () const
virtual void	setName (const char *nm)
bool	getNameFromPar (const IOPar &)
void	putNameInPar (IOPar &) const

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

Protected Member Functions
	IOObj (const char *nm=0, DBKey ky=DBKey::getInvalid())
	IOObj (const IOObj &)
bool	put (ascostream &) const
virtual bool	getFrom (ascistream &)=0
virtual bool	putTo (ascostream &) const =0

Static Protected Member Functions
static IOObj *	get (ascistream &, const char *, DirID, bool rejoldtmp=true)

Protected Attributes
BufferString	dirnm_
DBKey	key_
BufferString	transl_
BufferString	group_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
void	copyClassData (const IOObj &)

Static Private Member Functions
static IOObj *	produce (const char *, const char *nm, const DBKey &ky, bool initdefaults)

Private Attributes
IOPar &	pars_

Friends
class	DBDir

Detailed Description

Member Typedef Documentation

typedef DBKey::GroupID IOObj::DirID

typedef DBKey::ObjID IOObj::ObjID

typedef DBKey::ObjNrType IOObj::ObjNrType

Constructor & Destructor Documentation

virtual IOObj::~IOObj ( )

virtual

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

protected

IOObj::IOObj ( const IOObj &  )

protected

Member Function Documentation

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 IOX, IOSubDir, and IOStream.

void IOObj::copyClassData ( const IOObj &  )

private

virtual void IOObj::copyFrom ( const IOObj &  )

virtual

Reimplemented in IOStream, IOX, and IOSubDir.

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 *  , DirID  , bool  rejoldtmp = true  )

staticprotected

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

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

virtual bool IOObj::getFrom ( ascistream &  )

protectedpure virtual

Implemented in IOStream, IOX, and IOSubDir.

static const IOObj& IOObj::getInvalid ( )

static

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

bool IOObj::isInvalid ( ) const

inline

static bool IOObj::isKey ( const char *  )

static

Returns whether given string may be a valid key

bool IOObj::isProcTmp

(

)

const

virtual bool IOObj::isStream ( ) const

inlinevirtual

Reimplemented in IOStream.

virtual bool IOObj::isSubdir ( ) const

inlinevirtual

Reimplemented in IOSubDir.

static bool IOObj::isSurveyDefault ( const DBKey &  )

static

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

bool IOObj::isTmp ( ) const

inline

static bool IOObj::isTmpObjNr ( ObjNrType  nr )

inlinestatic

bool IOObj::isUserSelectable

(

bool

forread = true

)

const

virtual DBKey IOObj::key ( ) const

inlinevirtual

virtual BufferString IOObj::mainFileName ( ) const

inlinevirtual

Reimplemented in IOStream, and IOX.

virtual ObjID IOObj::objID ( ) const

inlinevirtual

virtual IOPar& IOObj::pars ( ) const

inlinevirtual

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

static IOObj* IOObj::produce ( const char *  , const char *  nm, const DBKey &  ky, bool  initdefaults  )

staticprivate

bool IOObj::put ( ascostream &  ) const

protected

virtual bool IOObj::putTo ( ascostream &  ) const

protectedpure virtual

Implemented in IOStream, IOX, and IOSubDir.

virtual void IOObj::setAbsDirectory ( const char *  )

inlinevirtual

Reimplemented in IOStream.

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

inlinevirtual

Reimplemented in IOStream.

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

inlinevirtual

void IOObj::setKey ( const DBKey &  ky )

inline

void IOObj::setKeyForNewEntry

(

DirID

)

This will mark the IOObj for DBM() as 'new'.

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 ObjNrType IOObj::tmpObjNrStart ( )

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 DBDir

friend

Member Data Documentation

BufferString IOObj::dirnm_

protected

BufferString IOObj::group_

protected

DBKey IOObj::key_

protected

IOPar& IOObj::pars_

private

BufferString IOObj::transl_

protected