Translator Class Reference

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

#include <transl.h>

Inheritance diagram for Translator:

Public Member Functions
virtual	~Translator ()
virtual const char *	connType () const
virtual IOObj *	createWriteIOObj (const IOObjContext &, const MultiID &) const
virtual const char *	defExtension () const
virtual const char *	defImplExtension () const
virtual void	getAllFileNames (BufferStringSet &, bool forui=false) const
virtual bool	getConfirmRemoveMsg (const IOObj *, uiString &msg, uiString &canceltxt, uiString &deepremovetxt, uiString &shallowremovetxt) const
const char *	getDisplayName () const
	"username [group]"
virtual od_int64	getFileSize (const IOObj *=nullptr) const
virtual Translator *	getNew () const =0
mOD_DisableCopy(Translator) const OD const TranslatorGroup *	group () const
virtual const char *	iconName () const
virtual bool	implExists (const IOObj *, bool forread) const
virtual void	implFileNames (const IOObj *, BufferStringSet &) const
virtual bool	implIsLink (const IOObj *) const
virtual bool	implReadOnly (const IOObj *) const
virtual bool	implRelocate (const IOObj *, const char *newfnm, const char *oldfnm=nullptr)
virtual bool	implRemove (const IOObj *, bool deep=true) const
virtual bool	implRename (const IOObj *, const char *newnm) const
virtual bool	implSetReadOnly (const IOObj *, bool) const
virtual bool	isUserSelectable (bool forread=true) const
virtual const uiString &	message () const
virtual int	nrImpls (const IOObj *) const
void	setGroup (TranslatorGroup *g)
uiString	sSelObjectIsWrongType ()
virtual bool	supportsReadFromCloud () const
virtual bool	supportsWriteToCloud () const
virtual void	usePar (const IOPar &)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object.
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use.
CallBacker &	operator= (const CallBacker &)=delete
void	stopReceivingNotifications () const
virtual CallBacker *	trueCaller ()

Static Public Member Functions
static const Translator *	getTemplateInstance (const char *displayname)
static uiString	sBadConnection ()
static uiString	sNoIoobjMsg ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Protected Member Functions
	Translator (const char *nm, const char *usr_nm)

Static Protected Member Functions
static BufferString	getAssociatedFileName (const char *fnm, const char *extension)
static BufferString	getAssociatedFileName (const IOObj &, const char *extension)
static bool	removeAssociatedFile (const char *fnm, const char *ext)
static bool	renameAssociatedFile (const char *fnm, const char *ext, const char *newnm)
static bool	renameLargeFile (const char *fnm, const char *newfnm, const CallBack *cb=nullptr)
static bool	setPermAssociatedFile (const char *fnm, const char *ext, bool setwritable)

Protected Attributes
TranslatorGroup *	group_ = nullptr
uiString	msg_
BufferString	typname_
BufferString	usrname_

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

~Translator()

virtual Translator::~Translator ( )

virtual

Translator()

Translator::Translator ( const char * nm, const char * usr_nm )

protected

Member Function Documentation

connType()

virtual const char * Translator::connType ( ) const

virtual

Reimplemented in SeisPSCubeSeisTrcTranslator.

createWriteIOObj()

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

virtual

Reimplemented in SEGYDirectSeisTrcTranslator.

defExtension()

virtual const char * Translator::defExtension ( ) const

virtual

Reimplemented in ODImageDefTranslator, dgbSurvGeom2DTranslator, SEGYDirectSeisPS3DTranslator, SEGYDirectSeisTrcTranslator, SEGYSeisTrcTranslator, TwoDSeisTrcTranslator, BlocksSeisTrcTranslator, CBVSSeisTrcTranslator, MultiCubeSeisPS3DTranslator, hdfWellTranslator, and odWellTranslator.

defImplExtension()

virtual const char * Translator::defImplExtension ( ) const

inlinevirtual

Reimplemented in SEGYDirectSeisTrcTranslator.

getAllFileNames()

virtual void Translator::getAllFileNames ( BufferStringSet & , bool forui = false ) const

virtual

Reimplemented in SEGYDirectSeisTrcTranslator, CBVSSeisTrcTranslator, and SeisTrcTranslator.

getAssociatedFileName() [1/2]

static BufferString Translator::getAssociatedFileName ( const char * fnm, const char * extension )

staticprotected

getAssociatedFileName() [2/2]

static BufferString Translator::getAssociatedFileName ( const IOObj & , const char * extension )

staticprotected

getConfirmRemoveMsg()

virtual bool Translator::getConfirmRemoveMsg ( const IOObj * , uiString & msg, uiString & canceltxt, uiString & deepremovetxt, uiString & shallowremovetxt ) const

virtual

if deepremove option is selected by user, the implRemove call gets deep=true

Reimplemented in SEGYDirectSeisTrcTranslator, SEGYDirectSeisTrc2DTranslator, and CBVSSeisTrcTranslator.

getDisplayName()

const char * Translator::getDisplayName

(

)

const

"username [group]"

getFileSize()

virtual od_int64 Translator::getFileSize ( const IOObj * = nullptr ) const

virtual

Reimplemented in SEGYDirectSeisTrcTranslator, SEGYSeisTrcTranslator, SeisTrc2DTranslator, and CBVSSeisTrcTranslator.

getNew()

virtual Translator * Translator::getNew ( ) const

pure virtual

getTemplateInstance()

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

static

group()

mOD_DisableCopy(Translator) const OD const TranslatorGroup * Translator::group ( ) const

inline

iconName()

virtual const char * Translator::iconName ( ) const

inlinevirtual

Reimplemented in SEGYDirectSeisPS3DTranslator, SEGYDirectSeisTrcTranslator, SEGYDirectSeisTrc2DTranslator, BlocksSeisTrcTranslator, hdfWellTranslator, and odWellTranslator.

implExists()

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

virtual

implFileNames()

virtual void Translator::implFileNames ( const IOObj * , BufferStringSet &  ) const

virtual

Reimplemented in SEGYDirectSeisTrcTranslator, and CBVSSeisTrcTranslator.

implIsLink()

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

virtual

Reimplemented in SEGYDirectSeisTrcTranslator, SEGYSeisTrcTranslator, CBVSSeisTrcTranslator, and SeisPSCubeSeisTrcTranslator.

implReadOnly()

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

virtual

implRelocate()

virtual bool Translator::implRelocate ( const IOObj * , const char * newfnm, const char * oldfnm = nullptr )

virtual

Reimplemented in SEGYDirectSeisTrcTranslator.

implRemove()

virtual bool Translator::implRemove ( const IOObj * , bool deep = true ) const

virtual

Reimplemented in odEMBodyTranslator, EMSurfaceTranslator, ODImageDefTranslator, PickSetTranslator, SEGYDirectSeisTrcTranslator, SEGYSeisTrcTranslator, TwoDSeisTrcTranslator, SeisTrc2DTranslator, SEGYDirectSeisTrc2DTranslator, CBVSSeisTrcTranslator, SeisPSCubeSeisTrcTranslator, SeisPS3DTranslator, CBVSSeisPS3DTranslator, CBVSSeisPS2DTranslator, StratTreeTranslator, and odWellTranslator.

implRename()

virtual bool Translator::implRename ( const IOObj * , const char * newnm ) const

virtual

Reimplemented in odEMBodyTranslator, EMSurfaceTranslator, ODImageDefTranslator, dgbSurvGeom2DTranslator, PickSetTranslator, TwoDSeisTrcTranslator, SeisTrc2DTranslator, CBVSSeisTrcTranslator, SeisPSCubeSeisTrcTranslator, SeisPS3DTranslator, StratTreeTranslator, WellTranslator, hdfWellTranslator, and odWellTranslator.

implSetReadOnly()

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

virtual

Reimplemented in EMSurfaceTranslator, CBVSSeisTrcTranslator, SeisPSCubeSeisTrcTranslator, StratTreeTranslator, and odWellTranslator.

isUserSelectable()

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

inlinevirtual

Reimplemented in BlocksSeisTrcTranslator, hdfWellTranslator, odWellTranslator, SEGYDirectSurvGeom2DTranslator, SEGYDirectSeisPS3DTranslator, SEGYDirectSeisPS2DTranslator, SEGYDirectSeisTrc2DTranslator, MultiCubeSeisPS3DTranslator, SeisPSCubeSeisTrcTranslator, lmkEMStickSetTranslator, lmkEMFault3DTranslator, SEGYDirectSeisTrcTranslator, SeisTrc2DTranslator, CBVSSeisTrc2DTranslator, CBVSSeisTrcTranslator, and SeisTrcTranslator.

message()

virtual const uiString & Translator::message ( ) const

inlinevirtual

nrImpls()

virtual int Translator::nrImpls ( const IOObj * ) const

virtual

Reimplemented in SEGYDirectSeisTrcTranslator.

removeAssociatedFile()

static bool Translator::removeAssociatedFile ( const char * fnm, const char * ext )

staticprotected

renameAssociatedFile()

static bool Translator::renameAssociatedFile ( const char * fnm, const char * ext, const char * newnm )

staticprotected

renameLargeFile()

static bool Translator::renameLargeFile ( const char * fnm, const char * newfnm, const CallBack * cb = nullptr )

staticprotected

sBadConnection()

static uiString Translator::sBadConnection ( )

static

setGroup()

void Translator::setGroup ( TranslatorGroup * g )

inline

setPermAssociatedFile()

static bool Translator::setPermAssociatedFile ( const char * fnm, const char * ext, bool setwritable )

staticprotected

sNoIoobjMsg()

static uiString Translator::sNoIoobjMsg ( )

static

sSelObjectIsWrongType()

uiString Translator::sSelObjectIsWrongType

(

)

supportsReadFromCloud()

virtual bool Translator::supportsReadFromCloud ( ) const

inlinevirtual

supportsWriteToCloud()

virtual bool Translator::supportsWriteToCloud ( ) const

inlinevirtual

usePar()

virtual void Translator::usePar ( const IOPar & )

inlinevirtual

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

Member Data Documentation

group_

TranslatorGroup* Translator::group_ = nullptr

protected

msg_

uiString Translator::msg_

protected

typname_

BufferString Translator::typname_

protected

usrname_

BufferString Translator::usrname_

protected