VelocityDesc Class Reference

Public Types
enum	Type {   Unknown , Interval , RMS , Avg ,   Delta , Epsilon , Eta }

Public Member Functions
	VelocityDesc ()
	VelocityDesc (OD::VelocityType, const char *unitstr=nullptr)
	VelocityDesc (Type)
void	fillPar (IOPar &) const
OD::VelocityType	getType () const
bool	isAvg () const
bool	isInterval () const
bool	isRMS () const
bool	isThomsen () const
bool	isUdf () const
bool	isVelocity () const
bool	operator!= (const VelocityDesc &) const
bool	operator== (const VelocityDesc &) const
void	setType (OD::VelocityType)
bool	usePar (const IOPar &)

Static Public Member Functions
static Type	get (OD::VelocityType)
static OD::VelocityType	get (Type)
static mDeprecatedDef uiString	getVelUnit (bool withparens=true)
static uiString	getVelVolumeLabel ()
static bool	isThomsen (OD::VelocityType)
static bool	isThomsen (Type)
static bool	isUdf (OD::VelocityType)
static bool	isUdf (Type)
static bool	isUsable (OD::VelocityType, const ZDomain::Def &, uiRetVal &)
static bool	isUsable (Type, const ZDomain::Def &, uiRetVal &)
static bool	isVelocity (OD::VelocityType)
static bool	isVelocity (Type)
static void	removePars (IOPar &)
static mDeprecatedDef const char *	sKeyIsFeetPerSecond ()
static mDeprecatedDef const char *	sKeyIsVelocity ()
static const char *	sKeyVelocityType ()
static const char *	sKeyVelocityUnit ()
static const char *	sKeyVelocityVolume ()

Public Attributes
StaticsDesc	statics_
Type	type_
BufferString	velunit_

Detailed Description

Specifies velocity type and statics for a velocity.

To tag a velocity volume as a velocity, this class can be used to do the work:

const VelocityDesc desc( OD::VelocityType::Interval );
 
PtrMan<IOObj> ioobj = IOM().get( multiid );
desc.fillPar( ioobj->pars() );
IOM().commitChanges( ioobj );

<>

Member Enumeration Documentation

Type

enum VelocityDesc::Type

Enumerator
Unknown
Interval
RMS
Avg
Delta
Epsilon
Eta

Constructor & Destructor Documentation

VelocityDesc() [1/3]

VelocityDesc::VelocityDesc

(

)

VelocityDesc() [2/3]

VelocityDesc::VelocityDesc

(

Type

)

VelocityDesc() [3/3]

VelocityDesc::VelocityDesc	(	OD::VelocityType	,
		const char *	unitstr = nullptr
	)

Member Function Documentation

fillPar()

void VelocityDesc::fillPar

(

IOPar &

)

const

get() [1/2]

static Type VelocityDesc::get ( OD::VelocityType  )

static

get() [2/2]

static OD::VelocityType VelocityDesc::get ( Type  )

static

getType()

OD::VelocityType VelocityDesc::getType

(

)

const

getVelUnit()

static mDeprecatedDef uiString VelocityDesc::getVelUnit ( bool  withparens = true )

static

getVelVolumeLabel()

static uiString VelocityDesc::getVelVolumeLabel ( )

static

isAvg()

bool VelocityDesc::isAvg

(

)

const

isInterval()

bool VelocityDesc::isInterval

(

)

const

isRMS()

bool VelocityDesc::isRMS

(

)

const

isThomsen() [1/3]

bool VelocityDesc::isThomsen

(

)

const

Returns

true if not unknown or a Velocity

isThomsen() [2/3]

static bool VelocityDesc::isThomsen ( OD::VelocityType  )

static

Returns

true if not unknown or a Velocity

isThomsen() [3/3]

static bool VelocityDesc::isThomsen ( Type  )

static

isUdf() [1/3]

bool VelocityDesc::isUdf

(

)

const

isUdf() [2/3]

static bool VelocityDesc::isUdf ( OD::VelocityType  )

static

isUdf() [3/3]

static bool VelocityDesc::isUdf ( Type  )

static

isUsable() [1/2]

static bool VelocityDesc::isUsable ( OD::VelocityType  , const ZDomain::Def &  , uiRetVal &    )

static

isUsable() [2/2]

static bool VelocityDesc::isUsable ( Type  , const ZDomain::Def &  , uiRetVal &    )

static

isVelocity() [1/3]

bool VelocityDesc::isVelocity

(

)

const

Returns

true if not unknown or a Thomsen parameter

isVelocity() [2/3]

static bool VelocityDesc::isVelocity ( OD::VelocityType  )

static

Returns

true if not unknown or a Thomsen parameter

isVelocity() [3/3]

static bool VelocityDesc::isVelocity ( Type  )

static

operator!=()

bool VelocityDesc::operator!=

(

const VelocityDesc &

)

const

operator==()

bool VelocityDesc::operator==

(

const VelocityDesc &

)

const

removePars()

static void VelocityDesc::removePars ( IOPar &  )

static

setType()

void VelocityDesc::setType

(

OD::VelocityType

)

sKeyIsFeetPerSecond()

static mDeprecatedDef const char* VelocityDesc::sKeyIsFeetPerSecond ( )

static

sKeyIsVelocity()

static mDeprecatedDef const char* VelocityDesc::sKeyIsVelocity ( )

static

sKeyVelocityType()

static const char* VelocityDesc::sKeyVelocityType ( )

static

sKeyVelocityUnit()

static const char* VelocityDesc::sKeyVelocityUnit ( )

static

sKeyVelocityVolume()

static const char* VelocityDesc::sKeyVelocityVolume ( )

static

usePar()

bool VelocityDesc::usePar

(

const IOPar &

)

Member Data Documentation

statics_

StaticsDesc VelocityDesc::statics_

type_

Type VelocityDesc::type_

velunit_

BufferString VelocityDesc::velunit_