Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Friends

IOObj Class Reference

Inheritance diagram for IOObj:
NamedObject CallBacker IOLink IOObject IOStream IOX

List of all members.

Public Member Functions

IOObjclone () const
IOObjgetParent () const
 Will return null for objects in the survey dir.
virtual const MultiIDkey () const
virtual ~IOObj ()
virtual bool bad () const =0
virtual bool isLink () const
virtual void copyFrom (const IOObj *)=0
virtual bool hasConnType (const char *s) const
virtual const char * connType () const =0
virtual ConngetConn (Conn::State) const =0
virtual bool slowOpen () const
virtual const MultiIDparentKey () const =0
virtual void setParentKey (const char *)=0
virtual const char * translator () const =0
virtual void setTranslator (const char *)=0
virtual const char * group () const =0
virtual void setGroup (const char *)=0
virtual const char * fullUserExpr (bool forread) const =0
virtual bool implExists (bool forread) const =0
virtual bool implReadOnly () const
virtual bool implRemove () const
virtual bool implShouldRemove () const
virtual bool implRename (const char *, const CallBack *cb=0)
virtual bool implSetReadOnly (bool) const
virtual bool removeQuery () const
virtual void genDefaultImpl ()
virtual const char * dirName () const
bool isStandAlone () const
 IOObjs can be dependent on the IODir.
void setStandAlone (const char *dirnm)
 uncouple IOObj from IODir
virtual IOParpars () const
 These are the extra parameters: xxx: yyy in .omf.
TranslatorgetTranslator () const
virtual void acquireNewKey ()
 This will give the IOObj a new (free) ID.
bool isTmp () const
bool isReadDefault () const

Static Public Member Functions

static bool isKey (const char *)
 Returns whether given string may be a valid key.
static bool isSurveyDefault (const MultiID &)
 Checks the 'Default.' entries in SI().pars().
static const int tmpID ()
static int addProducer (IOObjProducer *)
 Factory for IOObj types. Not for casual use.

Protected Member Functions

 IOObj (const char *nm=0, const char *ky=0)
 IOObj (IOObj *, const char *ky=0)
bool put (ascostream &) const
virtual bool getFrom (ascistream &)=0
virtual bool putTo (ascostream &) const =0
void setKey (const char *nm)

Static Protected Member Functions

static IOObjget (ascistream &, const char *, const char *)

Protected Attributes

FileNameString * dirname_
IOLinkmylink_
MultiID key_

Private Member Functions

int myKey () const

Static Private Member Functions

static IOObjproduce (const char *, const char *nm=0, const char *ky=0, bool initdefaults=true)

Private Attributes

IOParpars_

Friends

class IODir
class IOLink

Constructor & Destructor Documentation

virtual IOObj::~IOObj (  )  [virtual]
IOObj::IOObj ( const char *  nm = 0,
const char *  ky = 0 
) [protected]
IOObj::IOObj ( IOObj ,
const char *  ky = 0 
) [protected]

Member Function Documentation

virtual void IOObj::acquireNewKey (  )  [virtual]

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

Reimplemented in IOLink.

static int IOObj::addProducer ( IOObjProducer  )  [static]

Factory for IOObj types. Not for casual use.

virtual bool IOObj::bad (  )  const [pure virtual]

Implemented in IOLink, IOStream, and IOX.

IOObj* IOObj::clone (  )  const
virtual const char* IOObj::connType (  )  const [pure virtual]

Implemented in IOLink, IOStream, and IOX.

virtual void IOObj::copyFrom ( const IOObj  )  [pure virtual]

Implemented in IOLink, IOStream, and IOX.

virtual const char* IOObj::dirName (  )  const [virtual]

The full path to the position in the tree

Note:
may not be the directory of an implementation

Reimplemented in IOLink.

virtual const char* IOObj::fullUserExpr ( bool  forread  )  const [pure virtual]

Implemented in IOLink, IOStream, and IOX.

virtual void IOObj::genDefaultImpl (  )  [inline, virtual]

Reimplemented in IOLink, IOStream, and IOX.

static IOObj* IOObj::get ( ascistream ,
const char *  ,
const char *   
) [static, protected]
virtual Conn* IOObj::getConn ( Conn::State   )  const [pure virtual]

Implemented in IOLink, IOStream, and IOX.

virtual bool IOObj::getFrom ( ascistream  )  [protected, pure virtual]

Implemented in IOLink, IOStream, and IOX.

IOObj* IOObj::getParent (  )  const

Will return null for objects in the survey dir.

Translator* IOObj::getTranslator (  )  const

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

virtual const char* IOObj::group (  )  const [pure virtual]

Implemented in IOLink, and IOObject.

virtual bool IOObj::hasConnType ( const char *  s  )  const [inline, virtual]

Reimplemented in IOLink.

virtual bool IOObj::implExists ( bool  forread  )  const [pure virtual]

Implemented in IOLink, IOStream, and IOX.

virtual bool IOObj::implReadOnly (  )  const [inline, virtual]

Reimplemented in IOLink, and IOStream.

virtual bool IOObj::implRemove (  )  const [inline, virtual]

Reimplemented in IOLink, and IOStream.

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

Reimplemented in IOStream.

virtual bool IOObj::implSetReadOnly ( bool   )  const [inline, virtual]

Reimplemented in IOLink, and IOStream.

virtual bool IOObj::implShouldRemove (  )  const [inline, virtual]

Reimplemented in IOLink, IOStream, and IOX.

static bool IOObj::isKey ( const char *   )  [static]

Returns whether given string may be a valid key.

virtual bool IOObj::isLink (  )  const [inline, virtual]

Reimplemented in IOLink.

bool IOObj::isReadDefault (  )  const
bool IOObj::isStandAlone (  )  const [inline]

IOObjs can be dependent on the IODir.

static bool IOObj::isSurveyDefault ( const MultiID  )  [static]

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

bool IOObj::isTmp (  )  const [inline]
virtual const MultiID& IOObj::key (  )  const [inline, virtual]
int IOObj::myKey (  )  const [private]
virtual const MultiID& IOObj::parentKey (  )  const [pure virtual]

Implemented in IOLink, and IOObject.

virtual IOPar& IOObj::pars (  )  const [inline, virtual]

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 
) [static, private]
bool IOObj::put ( ascostream  )  const [protected]
virtual bool IOObj::putTo ( ascostream  )  const [protected, pure virtual]

Implemented in IOLink, IOStream, and IOX.

virtual bool IOObj::removeQuery (  )  const [inline, virtual]

Reimplemented in IOLink.

virtual void IOObj::setGroup ( const char *   )  [pure virtual]

Implemented in IOLink, and IOObject.

void IOObj::setKey ( const char *  nm  )  [inline, protected]
virtual void IOObj::setParentKey ( const char *   )  [pure virtual]

Implemented in IOLink, and IOObject.

void IOObj::setStandAlone ( const char *  dirnm  ) 

uncouple IOObj from IODir

virtual void IOObj::setTranslator ( const char *   )  [pure virtual]

Implemented in IOLink, and IOObject.

virtual bool IOObj::slowOpen (  )  const [inline, virtual]

Reimplemented in IOLink, IOStream, and IOX.

static const int IOObj::tmpID (  )  [inline, static]
virtual const char* IOObj::translator (  )  const [pure virtual]

Implemented in IOLink, and IOObject.


Friends And Related Function Documentation

friend class IODir [friend]
friend class IOLink [friend]

Member Data Documentation

FileNameString* IOObj::dirname_ [protected]
MultiID IOObj::key_ [protected]
IOLink* IOObj::mylink_ [protected]
IOPar& IOObj::pars_ [private]