Translator Class Reference

I/O Interpreter class for a certain object type. More...

Inheritance diagram for Translator:

Public Member Functions
uiString	sSelObjectIsWrongType ()
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 uiString	sNoIoobjMsg ()
static uiString	sBadConnection ()

Protected Attributes
BufferString	typname_
BufferString	usrname_
TranslatorGroup *	group_

Private Member Functions
virtual mODTextTranslationClass(Translator) public	~Translator ()
const OD::String &	typeName () const
const OD::String &	userName () const
const TranslatorGroup *	group () const
virtual Translator *	getNew () const =0
virtual bool	implExists (const IOObj *, bool forread) const
virtual bool	implReadOnly (const IOObj *) const
virtual bool	implRename (const IOObj *, const char *, const CallBack *cb=0) const
virtual bool	implManagesObjects (const IOObj *) const
virtual bool	implRemove (const IOObj *) const
virtual bool	implSetReadOnly (const IOObj *, bool) const
virtual const char *	connType () const
virtual void	usePar (const IOPar &)
virtual const char *	defExtension () const
void	setGroup (TranslatorGroup *g)
virtual bool	isUserSelectable (bool forread=true) const
virtual IOObj *	createWriteIOObj (const IOObjContext &, const MultiID &) const
virtual const char *	iconName () const
const char *	getDisplayName () const
	"username [group]" More...

Static Private Member Functions
static const Translator *	getTemplateInstance (const char *displayname)

Additional Inherited Members
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Detailed Description

I/O Interpreter class for a certain object type.

Every concept (Well, Seismic data, etc.) should have its own Translator base class. Together with the Group, you then get 2 + N classes per concept: XxxTranslatorGroup XxxTranslator yyyXxxTranslator The XxxTranslator defines the 'protocol' for reading and writing objects of this type. Actual I/O will always be done through a pointer to that type.

Important: use the macros at the end of this header file to declare and define every Translator(Group)-related class.

Constructor & Destructor Documentation

virtual mODTextTranslationClass (Translator) public Translator::~Translator ( )

inlineprivatevirtual

Member Function Documentation

virtual const char* Translator::connType ( ) const

privatevirtual

Reimplemented in SeisPSCubeSeisTrcTranslator.

virtual IOObj* Translator::createWriteIOObj ( const IOObjContext &  , const MultiID &    ) const

privatevirtual

Reimplemented in SEGYDirectSeisTrcTranslator.

virtual const char* Translator::defExtension ( ) const

inlineprivatevirtual

Reimplemented in SEGYDirectSeisTrcTranslator, TwoDSeisTrcTranslator, CBVSSeisTrcTranslator, dgbSurvGeom2DTranslator, SEGYSeisTrcTranslator, and BlocksSeisTrcTranslator.

const char* Translator::getDisplayName ( ) const

private

"username [group]"

virtual Translator* Translator::getNew ( ) const

privatepure virtual

Implemented in dgbSurvGeom2DTranslator, dgbPosProvidersTranslator, dgbPreLoadSurfacesTranslator, dgbPreLoadsTranslator, odElasticPropSelectionTranslator, odIOObjSelectionTranslator, and odMathFormulaTranslator.

static const Translator* Translator::getTemplateInstance ( const char *  displayname )

staticprivate

const TranslatorGroup* Translator::group ( ) const

inlineprivate

virtual const char* Translator::iconName ( ) const

inlineprivatevirtual

Reimplemented in SEGYDirectSeisTrc2DTranslator, SEGYDirectSeisTrcTranslator, and BlocksSeisTrcTranslator.

virtual bool Translator::implExists ( const IOObj *  , bool  forread  ) const

privatevirtual

virtual bool Translator::implManagesObjects ( const IOObj *  ) const

privatevirtual

Reimplemented in SEGYSeisTrcTranslator.

virtual bool Translator::implReadOnly ( const IOObj *  ) const

privatevirtual

virtual bool Translator::implRemove ( const IOObj *  ) const

privatevirtual

Reimplemented in SEGYDirectSeisTrcTranslator, SeisTrc2DTranslator, EMSurfaceTranslator, TwoDSeisTrcTranslator, PickSetTranslator, odWellTranslator, CBVSSeisTrcTranslator, and SeisPSCubeSeisTrcTranslator.

virtual bool Translator::implRename ( const IOObj *  , const char *  , const CallBack *  cb = 0  ) const

privatevirtual

Reimplemented in SeisTrc2DTranslator, EMSurfaceTranslator, TwoDSeisTrcTranslator, PickSetTranslator, odWellTranslator, dgbSurvGeom2DTranslator, CBVSSeisTrcTranslator, and SeisPSCubeSeisTrcTranslator.

virtual bool Translator::implSetReadOnly ( const IOObj *  , bool    ) const

privatevirtual

Reimplemented in EMSurfaceTranslator, odWellTranslator, CBVSSeisTrcTranslator, and SeisPSCubeSeisTrcTranslator.

virtual bool Translator::isUserSelectable ( bool  forread = true ) const

inlineprivatevirtual

Reimplemented in SeisTrcTranslator, SEGYDirectSeisTrc2DTranslator, CBVSSeisTrc2DTranslator, SeisTrc2DTranslator, SEGYDirectSeisTrcTranslator, SEGYDirectSurvGeom2DTranslator, lmkEMStickSetTranslator, CBVSSeisTrcTranslator, SeisPSCubeSeisTrcTranslator, lmkEMFault3DTranslator, and BlocksSeisTrcTranslator.

static uiString Translator::sBadConnection ( )

static

void Translator::setGroup ( TranslatorGroup *  g )

inlineprivate

static uiString Translator::sNoIoobjMsg ( )

static

uiString Translator::sSelObjectIsWrongType

(

)

const OD::String& Translator::typeName ( ) const

inlineprivate

virtual void Translator::usePar ( const IOPar &  )

inlineprivatevirtual

Reimplemented in SeisTrcTranslator, SEGYDirectSeisTrcTranslator, SEGYSeisTrcTranslator, CBVSSeisTrcTranslator, and BlocksSeisTrcTranslator.

const OD::String& Translator::userName ( ) const

inlineprivate

Member Data Documentation

TranslatorGroup* Translator::group_

protected

BufferString Translator::typname_

protected

BufferString Translator::usrname_

protected