VelocityDesc Class Reference

#include <veldesc.h>

Public Member Functions
	VelocityDesc ()
	VelocityDesc (OD::VelocityType, const UnitOfMeasure *=nullptr)
	~VelocityDesc ()
void	fillPar (IOPar &) const
const UnitOfMeasure *	getUnit () const
bool	hasVelocityUnit () 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	setUnit (const UnitOfMeasure *)
bool	usePar (const IOPar &)

Static Public Member Functions
static uiString	getVelVolumeLabel ()
static bool	isThomsen (OD::VelocityType)
static bool	isUdf (OD::VelocityType)
static bool	isUsable (OD::VelocityType, const ZDomain::Def &, uiRetVal &)
static bool	isVelocity (OD::VelocityType)
static void	removePars (IOPar &)
static const char *	sKeyVelocityType ()
static const char *	sKeyVelocityUnit ()
static const char *	sKeyVelocityVolume ()

Public Attributes
StaticsDesc	statics_
OD::VelocityType	type_ = OD::VelocityType::Unknown

Private Attributes
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 );

<>

Constructor & Destructor Documentation

VelocityDesc() [1/2]

VelocityDesc::VelocityDesc

(

)

VelocityDesc() [2/2]

VelocityDesc::VelocityDesc	(	OD::VelocityType	,
		const UnitOfMeasure *	= nullptr )

~VelocityDesc()

VelocityDesc::~VelocityDesc

(

)

Member Function Documentation

fillPar()

void VelocityDesc::fillPar

(

IOPar &

)

const

getUnit()

const UnitOfMeasure * VelocityDesc::getUnit

(

)

const

getVelVolumeLabel()

static uiString VelocityDesc::getVelVolumeLabel ( )

static

hasVelocityUnit()

bool VelocityDesc::hasVelocityUnit

(

)

const

isAvg()

bool VelocityDesc::isAvg

(

)

const

isInterval()

bool VelocityDesc::isInterval

(

)

const

isRMS()

bool VelocityDesc::isRMS

(

)

const

isThomsen() [1/2]

bool VelocityDesc::isThomsen

(

)

const

Returns

true if not unknown or a Velocity

isThomsen() [2/2]

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

static

Returns

true if not unknown or a Velocity

isUdf() [1/2]

bool VelocityDesc::isUdf

(

)

const

isUdf() [2/2]

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

static

isUsable()

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

static

isVelocity() [1/2]

bool VelocityDesc::isVelocity

(

)

const

Returns

true if not unknown or a Thomsen parameter

isVelocity() [2/2]

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

static

Returns

true if not unknown or a Thomsen parameter

operator!=()

bool VelocityDesc::operator!=

(

const VelocityDesc &

)

const

operator==()

bool VelocityDesc::operator==

(

const VelocityDesc &

)

const

removePars()

static void VelocityDesc::removePars ( IOPar & )

static

setUnit()

void VelocityDesc::setUnit

(

const UnitOfMeasure *

)

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_

OD::VelocityType VelocityDesc::type_ = OD::VelocityType::Unknown

velunit_

BufferString VelocityDesc::velunit_

private