IOObj Class Reference

#include <ioobj.h>

Inheritance diagram for IOObj:

Public Types
enum class	Status {   Unknown =0 , OK =1 , FileNotPresent =2 , ReadPermissionInvalid =3 ,   WrongObject =4 , BrokenLink =5 , FileEmpty =6 , FileDataCorrupt =7 ,   LibraryNotLoaded =8 , DataVersionInvalid =9 , Other =10 }
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
virtual	~IOObj ()
void	acquireNewKeyIn (const MultiID &)
	This will give the IOObj a new (free) ID.
IOObj *	clone () const
virtual const char *	connType () const =0
virtual void	copyFrom (const IOObj *)=0
Translator *	createTranslator () const
virtual const char *	dirName () const
	The directory ame within the tree.
virtual const OD::DataSetKey *	DSKey () const
virtual const char *	fullUserExpr (bool forread=true) const =0
virtual Conn *	getConn (bool forread) const =0
virtual const OD::String &	group () const
virtual bool	hasConnType (const char *s) const
virtual bool	hasDSKey () const
virtual bool	implExists (bool forread) const =0
virtual void	implFileNames (BufferStringSet &) const
virtual bool	implIsLink () const
virtual bool	implReadOnly () const
virtual bool	implRemove () const
virtual bool	implRename (const char *)
virtual bool	implSetReadOnly (bool) const
virtual bool	isBad () const =0
bool	isInCurrentSurvey () const
bool	isProcTmp () const
virtual bool	isSubdir () const
bool	isTmp () const
bool	isUserSelectable (bool forread=true) const
virtual const MultiID &	key () const
virtual BufferString	mainFileName () const
virtual int	nrImpls () const
virtual IOPar &	pars () const
uiString	phrCannotLoadObj () const
uiString	phrCannotOpenObj () const
uiString	phrCannotReadObj () const
uiString	phrCannotWriteObj () const
uiString	phrCannotWriteToDB () const
virtual void	setDirName (const char *s)
virtual void	setDSKey (const OD::DataSetKey &)
virtual void	setGroup (const char *s)
void	setKey (const char *nm)
void	setKey (const MultiID &key)
virtual void	setStatus (Status st)
void	setSurveyDefault () const
virtual void	setTranslator (const char *s)
virtual Status	status () const
virtual const OD::String &	translator () const
uiString	uiName () const
void	updateCreationPars () 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 &)
const name_type &	name () const override
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

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

Protected Member Functions
	IOObj (const char *nm, const char *kystr)
	IOObj (const char *nm, const DBKey &)
	IOObj (const char *nm, const MultiID &)
	IOObj (const IOObj &)
virtual bool	getFrom (ascistream &)=0
virtual int	myKey () const
bool	put (ascostream &) const
virtual bool	putTo (ascostream &) const =0

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

Protected Attributes
BufferString	dirnm_
const OD::DataSetKey *	dskey_ = nullptr
BufferString	group_
MultiID	key_
Status	status_ = Status::Unknown
BufferString	transl_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
void	copyStuffFrom (const IOObj &)

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

Private Attributes
IOPar &	pars_

Friends
class	IODir

Detailed Description

<>

Member Enumeration Documentation

Status

enum class IOObj::Status

strong

Enumerator
Unknown
OK
FileNotPresent
ReadPermissionInvalid
WrongObject
BrokenLink
FileEmpty
FileDataCorrupt
LibraryNotLoaded
DataVersionInvalid
Other

Constructor & Destructor Documentation

~IOObj()

virtual IOObj::~IOObj ( )

virtual

IOObj() [1/4]

IOObj::IOObj ( const char * nm, const DBKey &  )

protected

IOObj() [2/4]

IOObj::IOObj ( const IOObj & )

protected

IOObj() [3/4]

IOObj::IOObj ( const char * nm, const MultiID &  )

protected

IOObj() [4/4]

IOObj::IOObj ( const char * nm, const char * kystr )

protected

Member Function Documentation

acquireNewKeyIn()

void IOObj::acquireNewKeyIn

(

const MultiID &

)

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

addProducer()

static int IOObj::addProducer ( IOObjProducer * )

static

Factory for IOObj types. Not for casual use.

clone()

IOObj * IOObj::clone

(

)

const

connType()

virtual const char * IOObj::connType ( ) const

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

copyFrom()

virtual void IOObj::copyFrom ( const IOObj * )

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

copyStuffFrom()

void IOObj::copyStuffFrom ( const IOObj & )

private

createTranslator()

Translator * IOObj::createTranslator

(

)

const

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

dirName()

virtual const char * IOObj::dirName ( ) const

inlinevirtual

The directory ame within the tree.

Reimplemented in IOX, and IOSubDir.

DSKey()

virtual const OD::DataSetKey * IOObj::DSKey ( ) const

virtual

fullUserExpr()

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

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

get()

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

staticprotected

getConn()

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

pure virtual

Implemented in IOSubDir, IOStream, and IOX.

getFrom()

virtual bool IOObj::getFrom ( ascistream & )

protectedpure virtual

Implemented in IOStream, IOX, and IOSubDir.

group()

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

inlinevirtual

hasConnType()

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

inlinevirtual

hasDSKey()

virtual bool IOObj::hasDSKey ( ) const

virtual

implExists()

virtual bool IOObj::implExists ( bool forread ) const

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

implFileNames()

virtual void IOObj::implFileNames ( BufferStringSet & ) const

virtual

implIsLink()

virtual bool IOObj::implIsLink ( ) const

virtual

implReadOnly()

virtual bool IOObj::implReadOnly ( ) const

inlinevirtual

Reimplemented in IOStream, and IOSubDir.

implRemove()

virtual bool IOObj::implRemove ( ) const

inlinevirtual

Reimplemented in IOStream, and IOSubDir.

implRename()

virtual bool IOObj::implRename ( const char * )

inlinevirtual

Reimplemented in IOStream, and IOSubDir.

implSetReadOnly()

virtual bool IOObj::implSetReadOnly ( bool ) const

inlinevirtual

Reimplemented in IOStream, and IOSubDir.

isBad()

virtual bool IOObj::isBad ( ) const

pure virtual

Implemented in IOStream, IOX, and IOSubDir.

isInCurrentSurvey()

bool IOObj::isInCurrentSurvey

(

)

const

isKey()

static bool IOObj::isKey ( const char * )

static

Returns whether given string may be a valid key

isProcTmp()

bool IOObj::isProcTmp

(

)

const

isSubdir()

virtual bool IOObj::isSubdir ( ) const

inlinevirtual

Reimplemented in IOSubDir.

isSurveyDefault()

static bool IOObj::isSurveyDefault ( const MultiID & )

static

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

isTmp()

bool IOObj::isTmp ( ) const

inline

isUserSelectable()

bool IOObj::isUserSelectable

(

bool

forread = true

)

const

key()

virtual const MultiID & IOObj::key ( ) const

inlinevirtual

mainFileName()

virtual BufferString IOObj::mainFileName ( ) const

inlinevirtual

Reimplemented in IOStream.

myKey()

virtual int IOObj::myKey ( ) const

protectedvirtual

Reimplemented in IOSubDir.

nrImpls()

virtual int IOObj::nrImpls ( ) const

virtual

pars()

virtual IOPar & IOObj::pars ( ) const

inlinevirtual

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

phrCannotLoadObj()

uiString IOObj::phrCannotLoadObj

(

)

const

phrCannotOpenObj()

uiString IOObj::phrCannotOpenObj

(

)

const

phrCannotReadObj()

uiString IOObj::phrCannotReadObj

(

)

const

phrCannotWriteObj()

uiString IOObj::phrCannotWriteObj

(

)

const

phrCannotWriteToDB()

uiString IOObj::phrCannotWriteToDB

(

)

const

produce()

static IOObj * IOObj::produce ( const char * typ, const char * nm, const DBKey & , bool initdefaults = true )

staticprivate

put()

bool IOObj::put ( ascostream & ) const

protected

putTo()

virtual bool IOObj::putTo ( ascostream & ) const

protectedpure virtual

Implemented in IOStream, IOX, and IOSubDir.

setDirName()

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

inlinevirtual

Reimplemented in IOStream.

setDSKey()

virtual void IOObj::setDSKey ( const OD::DataSetKey & )

virtual

setGroup()

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

inlinevirtual

setKey() [1/2]

void IOObj::setKey ( const char * nm )

inline

setKey() [2/2]

void IOObj::setKey ( const MultiID & key )

inline

setStatus()

virtual void IOObj::setStatus ( Status st )

inlinevirtual

setSurveyDefault()

void IOObj::setSurveyDefault

(

)

const

Parameters

subsel

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

setTranslator()

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

inlinevirtual

status()

virtual Status IOObj::status ( ) const

inlinevirtual

tmpID()

static int IOObj::tmpID ( )

inlinestatic

translator()

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

inlinevirtual

uiName()

uiString IOObj::uiName ( ) const

inline

updateCreationPars()

void IOObj::updateCreationPars

(

)

const

Friends And Related Symbol Documentation

IODir

friend class IODir

friend

Member Data Documentation

dirnm_

BufferString IOObj::dirnm_

protected

dskey_

const OD::DataSetKey* IOObj::dskey_ = nullptr

protected

group_

BufferString IOObj::group_

protected

key_

MultiID IOObj::key_

protected

pars_

IOPar& IOObj::pars_

private

status_

Status IOObj::status_ = Status::Unknown

protected

transl_

BufferString IOObj::transl_

protected