CtxtIOObj Class Reference

Holds an IOObjCtxt plus a pointer to an IOObj and/or an IOPar. More...

Inheritance diagram for CtxtIOObj:

Public Member Functions
	CtxtIOObj (const CtxtIOObj &)
	CtxtIOObj (const IOObjContext &, IOObj *o=nullptr)
	~CtxtIOObj ()
void	destroyAll ()
void	fillDefault (bool alsoifonlyone=true)
	gets Default.xx or does fillIfOnlyOne() More...
void	fillDefaultWithKey (const char *, bool alsoifonlyone=true)
	With alternate key. More...
void	fillIfOnlyOne ()
int	fillObj (bool mktmpifnew=false, int translidxfornew=-1)
BufferString	getName () const override
virtual const OD::String &	name () const override
void	setName (const char *nm) override
void	setObj (const MultiID &)
	destroys previous More...
void	setObj (IOObj *)
	destroys previous More...
void	setPar (IOPar *)
	destroys previous More...
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
bool	getNameFromPar (const IOPar &)
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
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

Public Attributes
IOObjContext &	ctxt
IOObjContext	ctxt_
IOObj *&	ioobj
IOObj *	ioobj_
IOPar *&	iopar
IOPar *	iopar_

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

Holds an IOObjCtxt plus a pointer to an IOObj and/or an IOPar.

Neither the IOObj nor the IOPar are managed by this object. But, when you use setObj or setPar, the old object pointed to will be deleted. If you don't want that, you'll have to just assign.

<>

Constructor & Destructor Documentation

CtxtIOObj() [1/2]

CtxtIOObj::CtxtIOObj	(	const IOObjContext &	,
		IOObj *	o = nullptr
	)

CtxtIOObj() [2/2]

CtxtIOObj::CtxtIOObj

(

const CtxtIOObj &

)

~CtxtIOObj()

CtxtIOObj::~CtxtIOObj

(

)

Member Function Documentation

destroyAll()

void CtxtIOObj::destroyAll

(

)

fillDefault()

void CtxtIOObj::fillDefault

(

bool

alsoifonlyone = true

)

gets Default.xx or does fillIfOnlyOne()

fillDefaultWithKey()

void CtxtIOObj::fillDefaultWithKey	(	const char *	,
		bool	alsoifonlyone = true
	)

With alternate key.

fillIfOnlyOne()

void CtxtIOObj::fillIfOnlyOne

(

)

replaces ioobj if there's only one That one must match the preconditions

fillObj()

int CtxtIOObj::fillObj	(	bool	mktmpifnew = false,
		int	translidxfornew = -1
	)

If ioobj not valid, fills using ctxt.name() return 0=fail, 1=existing found, 2=new made

getName()

BufferString CtxtIOObj::getName ( ) const

inlineoverridevirtual

Reimplemented from NamedObject.

name()

virtual const OD::String& CtxtIOObj::name ( ) const

inlineoverridevirtual

Reimplemented from NamedObject.

setName()

void CtxtIOObj::setName ( const char *  nm )

inlineoverridevirtual

Reimplemented from NamedObject.

setObj() [1/2]

void CtxtIOObj::setObj

(

const MultiID &

)

destroys previous

setObj() [2/2]

void CtxtIOObj::setObj

(

IOObj *

)

destroys previous

setPar()

void CtxtIOObj::setPar

(

IOPar *

)

destroys previous

Member Data Documentation

ctxt

IOObjContext& CtxtIOObj::ctxt

ctxt_

IOObjContext CtxtIOObj::ctxt_

ioobj

IOObj*& CtxtIOObj::ioobj

ioobj_

IOObj* CtxtIOObj::ioobj_

iopar

IOPar*& CtxtIOObj::iopar

iopar_

IOPar* CtxtIOObj::iopar_