UnitOfMeasure Class Reference

Unit of Measure. More...

Inheritance diagram for UnitOfMeasure:

Public Member Functions
	UnitOfMeasure ()
	UnitOfMeasure (const char *n, const char *s, double f, PropertyRef::StdType t=PropertyRef::Other)
	UnitOfMeasure (const UnitOfMeasure &uom)
UnitOfMeasure &	operator= (const UnitOfMeasure &)
const char *	symbol () const
PropertyRef::StdType	propType () const
const LinScaler &	scaler () const
void	setSymbol (const char *s)
void	setScaler (const LinScaler &s)
void	setPropType (PropertyRef::StdType t)
bool	isImperial () const
template<class T >
T	getSIValue (T inp) const
template<class T >
T	getUserValueFromSI (T inp) const
template<class T >
T	internalValue (T inp) const
template<class T >
T	userValue (T inp) const
Repos::Source	source () const
void	setSource (Repos::Source s)
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual BufferString	getName () const
virtual void	setName (const char *nm)
bool	getNameFromPar (const IOPar &)
void	putNameInPar (IOPar &) const

Static Public Member Functions
static const UnitOfMeasure *	getGuessed (const char *)
static const UnitOfMeasure *	surveyDefZUnit ()
	Default unit in displays (ms,m,ft) More...
static const UnitOfMeasure *	surveyDefZStorageUnit ()
	Default unit in storage (s,m,ft) More...
static const UnitOfMeasure *	surveyDefTimeUnit ()
	Default time unit in displays (ms) More...
static const UnitOfMeasure *	surveyDefDepthUnit ()
	Default depth unit in displays (m,ft) More...
static const UnitOfMeasure *	surveyDefDepthStorageUnit ()
	Default depth unit in storage (m,ft) More...
static const UnitOfMeasure *	surveyDefVelUnit ()
	Default velocity unit in displays (m/s,ft/s) More...
static uiString	surveyDefZUnitAnnot (bool symbol, bool withparens)
static uiString	surveyDefTimeUnitAnnot (bool symbol, bool withparens)
static uiString	surveyDefDepthUnitAnnot (bool symbol, bool withparens)
static uiString	surveyDefVelUnitAnnot (bool symbol, bool withparens)
static uiString	zUnitAnnot (bool time, bool symbol, bool withparens)
static IOPar &	currentDefaults ()
static void	saveCurrentDefaults ()

Protected Attributes
BufferString	symbol_
LinScaler	scaler_
PropertyRef::StdType	proptype_
Repos::Source	source_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
	mODTextTranslationClass (UnitOfMeasure)

Detailed Description

Unit of Measure.

Only linear transformations to SI units supported.

All units of measure in OpendTect are available through the UoMR() instance accessor of the singleton UnitOfMeasureRepository instance.

Constructor & Destructor Documentation

UnitOfMeasure::UnitOfMeasure ( )

inline

UnitOfMeasure::UnitOfMeasure ( const char *  n, const char *  s, double  f, PropertyRef::StdType  t = PropertyRef::Other  )

inline

UnitOfMeasure::UnitOfMeasure ( const UnitOfMeasure &  uom )

inline

Member Function Documentation

static IOPar& UnitOfMeasure::currentDefaults ( )

static

just a list of key -> unit of measure key can be property name or whatever seems good

static const UnitOfMeasure* UnitOfMeasure::getGuessed ( const char *  )

static

template<class T >

T UnitOfMeasure::getSIValue ( T  inp ) const

inline

template<class T >

T UnitOfMeasure::getUserValueFromSI ( T  inp ) const

inline

template<class T >

T UnitOfMeasure::internalValue ( T  inp ) const

inline

bool UnitOfMeasure::isImperial

(

)

const

UnitOfMeasure::mODTextTranslationClass ( UnitOfMeasure  )

private

UnitOfMeasure& UnitOfMeasure::operator=

(

const UnitOfMeasure &

)

PropertyRef::StdType UnitOfMeasure::propType ( ) const

inline

static void UnitOfMeasure::saveCurrentDefaults ( )

static

store as a user setting on Survey level this will be done automatically at survey changes

const LinScaler& UnitOfMeasure::scaler ( ) const

inline

void UnitOfMeasure::setPropType ( PropertyRef::StdType  t )

inline

void UnitOfMeasure::setScaler ( const LinScaler &  s )

inline

void UnitOfMeasure::setSource ( Repos::Source  s )

inline

void UnitOfMeasure::setSymbol ( const char *  s )

inline

Repos::Source UnitOfMeasure::source ( ) const

inline

static const UnitOfMeasure* UnitOfMeasure::surveyDefDepthStorageUnit ( )

static

Default depth unit in storage (m,ft)

static const UnitOfMeasure* UnitOfMeasure::surveyDefDepthUnit ( )

static

Default depth unit in displays (m,ft)

static uiString UnitOfMeasure::surveyDefDepthUnitAnnot ( bool  symbol, bool  withparens  )

static

static const UnitOfMeasure* UnitOfMeasure::surveyDefTimeUnit ( )

static

Default time unit in displays (ms)

static uiString UnitOfMeasure::surveyDefTimeUnitAnnot ( bool  symbol, bool  withparens  )

static

static const UnitOfMeasure* UnitOfMeasure::surveyDefVelUnit ( )

static

Default velocity unit in displays (m/s,ft/s)

static uiString UnitOfMeasure::surveyDefVelUnitAnnot ( bool  symbol, bool  withparens  )

static

static const UnitOfMeasure* UnitOfMeasure::surveyDefZStorageUnit ( )

static

Default unit in storage (s,m,ft)

static const UnitOfMeasure* UnitOfMeasure::surveyDefZUnit ( )

static

Default unit in displays (ms,m,ft)

static uiString UnitOfMeasure::surveyDefZUnitAnnot ( bool  symbol, bool  withparens  )

static

const char* UnitOfMeasure::symbol ( ) const

inline

template<class T >

T UnitOfMeasure::userValue ( T  inp ) const

inline

static uiString UnitOfMeasure::zUnitAnnot ( bool  time, bool  symbol, bool  withparens  )

static

Member Data Documentation

PropertyRef::StdType UnitOfMeasure::proptype_

protected

LinScaler UnitOfMeasure::scaler_

protected

Repos::Source UnitOfMeasure::source_

protected

BufferString UnitOfMeasure::symbol_

protected