Mnemonic Class Reference

Reference data common to measured logs and simulated properties. More...

Inheritance diagram for Mnemonic:

Public Types
enum	Scale { Linear , Logarithmic }
enum	StdType {   Ang , Anis , Area , Class ,   Comp , Den , Dist , ElaRa ,   ElPot , Fluid , GR , Imp ,   Perm , Pres , PresGrad , PresWt ,   Res , Son , Temp , Time ,   Vel , Volum , Vol , Other ,   Force }
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
	Mnemonic (const char *nm=nullptr, StdType=Other)
	Mnemonic (const Mnemonic &mnc)
virtual	~Mnemonic ()
BufferStringSet &	aliases ()
const BufferStringSet &	aliases () const
const char *	description () const
const UnitOfMeasure *	getDisplayInfo (const IOPar &, Scale &, Interval< float > &, BufferString &, OD::LineStyle &) const
const UnitOfMeasure *	getDisplayInfo (Scale &, Interval< float > &, BufferString &, OD::LineStyle &) const
float	getMatchValue (const char *nm) const
const Mnemonic *	getOrigin () const
bool	hasType (StdType t) const
bool	isCompatibleWith (const Mnemonic *) const
bool	isKnownAs (const char *) const
bool	isKnownAs (const char *, bool exactmatch) const
bool	isTemplate () const
bool	isUdf () const
bool	matches (const char *nm, bool matchaliases) const
bool	matches (const char *nm, bool matchaliases, float *matchval) const
	mExpStruct (General) DispDefs
bool	operator!= (const Mnemonic &) const
Mnemonic &	operator= (const Mnemonic &)
bool	operator== (const Mnemonic &) const
StdType	stdType () const
const UnitOfMeasure *	unit () const
	For conversions only, do not use to get the label. More...
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
virtual BufferString	getName () const
bool	getNameFromPar (const IOPar &)
const name_type &	name () const override
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual void	setName (const char *nm)
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

Static Public Member Functions
static const Mnemonic &	defAI ()
static const Mnemonic &	defDEN ()
static const Mnemonic &	defDT ()
static const Mnemonic &	defDTS ()
static const Mnemonic &	defFracDensity ()
static const Mnemonic &	defFracOrientation ()
static const Mnemonic &	defMD ()
static const Mnemonic &	defPHI ()
static const Mnemonic &	defPVEL ()
static const Mnemonic &	defSI ()
static const Mnemonic &	defSVEL ()
static const Mnemonic &	defSW ()
static const Mnemonic &	defTime ()
static const Mnemonic &	defTVD ()
static const Mnemonic &	defTVDGL ()
static const Mnemonic &	defTVDSD ()
static const Mnemonic &	defTVDSS ()
static const Mnemonic &	defVEL ()
static const Mnemonic &	distance ()
static Mnemonic *	getFromTemplate (const Mnemonic &, const char *customname, Repos::Source)
static float	getMatchValue (const char *str, const BufferStringSet &, bool exactmatch, bool hasaltnm=true)
static IOPar	getUserMnemonics ()
static BufferString	getUserMnemonicsFileName ()
static void	setUserMnemonics (const IOPar &)
static const char *	sKeyMnemonic ()
static StdType	surveyZType (const SurveyInfo *=nullptr)
static const Mnemonic &	undef ()
static const Mnemonic &	volume ()

Public Attributes
DispDefs	disp_

Protected Member Functions
void	fillPar (IOPar &) const
void	fromString (const char *)
void	usePar (const IOPar &)

Protected Attributes
BufferStringSet	aliases_
BufferString	logtypename_
StdType	stdtype_
const UnitOfMeasure *	uom_ = nullptr
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
void	setUnit (const char *lbl)

Friends
class	MnemonicSet

Detailed Description

Reference data common to measured logs and simulated properties.

We prepare for many variants of the name as is not uncommon in practice (Density, PVEL, SVEL, ...). The names will be unique - case insensitive, in the Set. Hence, identity is established case insensitive. Aliases are matched with a GlobExpr, so you can add with wildcards and the like.

<>

Member Enumeration Documentation

Scale

enum Mnemonic::Scale

Enumerator
Linear
Logarithmic

StdType

enum Mnemonic::StdType

Enumerator
Ang
Anis
Area
Class
Comp
Den
Dist
ElaRa
ElPot
Fluid
GR
Imp
Perm
Pres
PresGrad
PresWt
Res
Son
Temp
Time
Vel
Volum
Vol
Other
Force

Constructor & Destructor Documentation

Mnemonic() [1/2]

Mnemonic::Mnemonic	(	const char *	nm = nullptr,
		StdType	= Other
	)

Mnemonic() [2/2]

Mnemonic::Mnemonic

(

const Mnemonic &

mnc

)

~Mnemonic()

virtual Mnemonic::~Mnemonic ( )

virtual

Member Function Documentation

aliases() [1/2]

BufferStringSet& Mnemonic::aliases ( )

inline

aliases() [2/2]

const BufferStringSet& Mnemonic::aliases ( ) const

inline

defAI()

static const Mnemonic& Mnemonic::defAI ( )

static

defDEN()

static const Mnemonic& Mnemonic::defDEN ( )

static

defDT()

static const Mnemonic& Mnemonic::defDT ( )

static

defDTS()

static const Mnemonic& Mnemonic::defDTS ( )

static

defFracDensity()

static const Mnemonic& Mnemonic::defFracDensity ( )

static

defFracOrientation()

static const Mnemonic& Mnemonic::defFracOrientation ( )

static

defMD()

static const Mnemonic& Mnemonic::defMD ( )

static

defPHI()

static const Mnemonic& Mnemonic::defPHI ( )

static

defPVEL()

static const Mnemonic& Mnemonic::defPVEL ( )

static

defSI()

static const Mnemonic& Mnemonic::defSI ( )

static

defSVEL()

static const Mnemonic& Mnemonic::defSVEL ( )

static

defSW()

static const Mnemonic& Mnemonic::defSW ( )

static

defTime()

static const Mnemonic& Mnemonic::defTime ( )

static

defTVD()

static const Mnemonic& Mnemonic::defTVD ( )

static

defTVDGL()

static const Mnemonic& Mnemonic::defTVDGL ( )

static

defTVDSD()

static const Mnemonic& Mnemonic::defTVDSD ( )

static

defTVDSS()

static const Mnemonic& Mnemonic::defTVDSS ( )

static

defVEL()

static const Mnemonic& Mnemonic::defVEL ( )

static

description()

const char* Mnemonic::description

(

)

const

distance()

static const Mnemonic& Mnemonic::distance ( )

static

fillPar()

void Mnemonic::fillPar ( IOPar &  ) const

protected

fromString()

void Mnemonic::fromString ( const char *  )

protected

getDisplayInfo() [1/2]

const UnitOfMeasure* Mnemonic::getDisplayInfo	(	const IOPar &	,
		Scale &	,
		Interval< float > &	,
		BufferString &	,
		OD::LineStyle &
	)		const

getDisplayInfo() [2/2]

const UnitOfMeasure* Mnemonic::getDisplayInfo	(	Scale &	,
		Interval< float > &	,
		BufferString &	,
		OD::LineStyle &
	)		const

getFromTemplate()

static Mnemonic* Mnemonic::getFromTemplate ( const Mnemonic &  , const char *  customname, Repos::Source    )

static

getMatchValue() [1/2]

float Mnemonic::getMatchValue

(

const char *

nm

)

const

getMatchValue() [2/2]

static float Mnemonic::getMatchValue ( const char *  str, const BufferStringSet &  , bool  exactmatch, bool  hasaltnm = true  )

static

getOrigin()

const Mnemonic* Mnemonic::getOrigin

(

)

const

getUserMnemonics()

static IOPar Mnemonic::getUserMnemonics ( )

static

getUserMnemonicsFileName()

static BufferString Mnemonic::getUserMnemonicsFileName ( )

static

hasType()

bool Mnemonic::hasType ( StdType  t ) const

inline

isCompatibleWith()

bool Mnemonic::isCompatibleWith

(

const Mnemonic *

)

const

isKnownAs() [1/2]

bool Mnemonic::isKnownAs

(

const char *

)

const

isKnownAs() [2/2]

bool Mnemonic::isKnownAs	(	const char *	,
		bool	exactmatch
	)		const

isTemplate()

bool Mnemonic::isTemplate

(

)

const

isUdf()

bool Mnemonic::isUdf ( ) const

inline

matches() [1/2]

bool Mnemonic::matches	(	const char *	nm,
		bool	matchaliases
	)		const

matches() [2/2]

bool Mnemonic::matches	(	const char *	nm,
		bool	matchaliases,
		float *	matchval
	)		const

mExpStruct()

Mnemonic::mExpStruct ( General  )

inline

< Returns if changed

operator!=()

bool Mnemonic::operator!=

(

const Mnemonic &

)

const

operator=()

Mnemonic& Mnemonic::operator=

(

const Mnemonic &

)

operator==()

bool Mnemonic::operator==

(

const Mnemonic &

)

const

setUnit()

void Mnemonic::setUnit ( const char *  lbl )

private

setUserMnemonics()

static void Mnemonic::setUserMnemonics ( const IOPar &  )

static

sKeyMnemonic()

static const char* Mnemonic::sKeyMnemonic ( )

static

stdType()

StdType Mnemonic::stdType ( ) const

inline

surveyZType()

static StdType Mnemonic::surveyZType ( const SurveyInfo *  = nullptr )

static

undef()

static const Mnemonic& Mnemonic::undef ( )

static

unit()

const UnitOfMeasure* Mnemonic::unit ( ) const

inline

For conversions only, do not use to get the label.

usePar()

void Mnemonic::usePar ( const IOPar &  )

protected

volume()

static const Mnemonic& Mnemonic::volume ( )

static

Friends And Related Function Documentation

MnemonicSet

friend class MnemonicSet

friend

Member Data Documentation

aliases_

BufferStringSet Mnemonic::aliases_

protected

disp_

DispDefs Mnemonic::disp_

logtypename_

BufferString Mnemonic::logtypename_

protected

stdtype_

StdType Mnemonic::stdtype_

protected

uom_

const UnitOfMeasure* Mnemonic::uom_ = nullptr

protected