IOObjContext Class Reference

Holds the context for selecting and/or creating IOObjs. More...

Inheritance diagram for IOObjContext:

Classes
struct	StdDirData

Public Types
enum	StdSelType {   Seis =0, Surf, Loc, Feat,   WllInf, NLA, Misc, Attr,   Mdl, Geom, None }

Public Member Functions
	mDeclareEnumUtils (StdSelType)
	IOObjContext (const TranslatorGroup *, const char *prefname=0)
	IOObjContext (const IOObjContext &)
IOObjContext &	operator= (const IOObjContext &)
bool	validIOObj (const IOObj &) const
const char *	objectTypeName () const
bool	hasStdSelKey () const
MultiID	getSelKey () const
IOStream *	crDefaultWriteObj (const Translator &, const MultiID &) const
void	fillTrGroup () const
void	fixTranslator (const char *trusrnm)
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 int	totalNrStdDirs ()
static const StdDirData *	getStdDirData (StdSelType)
static BufferString	getDataDirName (StdSelType)
	Including legacy names - smart. More...

Public Attributes
StdSelType	stdseltype_
	intrinsics More...
const TranslatorGroup *	trgroup_
	Mandatory, must never be 0. More...
int	newonlevel_
	level 0 is survey dir More...
bool	multi_
	If true, multi allowed. More...
bool	forread_
	this selection only More...
MultiID	selkey_
	If set, overrules the 'standard'. More...
bool	maydooper_
	Will we allow add/remove etc? More...
BufferString	deftransl_
	Translator to use for new entry. More...
IOObjSelConstraints	toselect_
mDeprecated StdSelType &	stdseltype
mDeprecated const TranslatorGroup *&	trgroup
mDeprecated int &	newonlevel
mDeprecated bool &	multi
mDeprecated bool &	forread
mDeprecated MultiID &	selkey
mDeprecated bool &	maydooper
mDeprecated BufferString &	deftransl
mDeprecated IOObjSelConstraints &	toselect

Additional Inherited Members
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

Detailed Description

Holds the context for selecting and/or creating IOObjs.

Usually, this object is obtained by calling the ioContext() method of a certain TranslatorGroup.

Note, that if the StdSelType is set to None, you must provide the selkey or we'll be blobbing stuff in the root of the survey.

Member Enumeration Documentation

enum IOObjContext::StdSelType

Enumerator
Seis
Surf
Loc
Feat
WllInf
NLA
Misc
Attr
Mdl
Geom
None

Constructor & Destructor Documentation

IOObjContext::IOObjContext	(	const TranslatorGroup *	,
		const char *	prefname = 0
	)

IOObjContext::IOObjContext

(

const IOObjContext &

)

Member Function Documentation

IOStream* IOObjContext::crDefaultWriteObj	(	const Translator &	,
		const MultiID &
	)		const

void IOObjContext::fillTrGroup

(

)

const

Uses stdseltype_ to make a trgroup_ Should never be necessary

void IOObjContext::fixTranslator ( const char *  trusrnm )

inline

static BufferString IOObjContext::getDataDirName ( StdSelType  )

static

Including legacy names - smart.

MultiID IOObjContext::getSelKey

(

)

const

static const StdDirData* IOObjContext::getStdDirData ( StdSelType  )

static

bool IOObjContext::hasStdSelKey ( ) const

inline

IOObjContext::mDeclareEnumUtils

(

StdSelType

)

const char* IOObjContext::objectTypeName

(

)

const

IOObjContext& IOObjContext::operator=

(

const IOObjContext &

)

static int IOObjContext::totalNrStdDirs ( )

static

bool IOObjContext::validIOObj

(

const IOObj &

)

const

Member Data Documentation

mDeprecated BufferString& IOObjContext::deftransl

BufferString IOObjContext::deftransl_

Translator to use for new entry.

mDeprecated bool& IOObjContext::forread

bool IOObjContext::forread_

this selection only

mDeprecated bool& IOObjContext::maydooper

bool IOObjContext::maydooper_

Will we allow add/remove etc?

mDeprecated bool& IOObjContext::multi

bool IOObjContext::multi_

If true, multi allowed.

mDeprecated int& IOObjContext::newonlevel

int IOObjContext::newonlevel_

level 0 is survey dir

mDeprecated MultiID& IOObjContext::selkey

MultiID IOObjContext::selkey_

If set, overrules the 'standard'.

mDeprecated StdSelType& IOObjContext::stdseltype

StdSelType IOObjContext::stdseltype_

intrinsics

mDeprecated IOObjSelConstraints& IOObjContext::toselect

IOObjSelConstraints IOObjContext::toselect_

mDeprecated const TranslatorGroup*& IOObjContext::trgroup

const TranslatorGroup* IOObjContext::trgroup_

Mandatory, must never be 0.