Vel::Function Class Reference

Inheritance diagram for Vel::Function:

Public Member Functions
	Function (FunctionSource &)
virtual StepInterval< float >	getAvailableZ () const =0
const BinID &	getBinID () const
virtual const VelocityDesc &	getDesc () const
const StepInterval< float > &	getDesiredZ () const
Pos::GeomID	getGeomID () const
const FunctionSource &	getSource () const
float	getVelocity (float z) const
virtual bool	moveTo (const BinID &)
virtual void	removeCache ()
void	setDesiredZRange (const StepInterval< float > &)
void	setGeomID (const Pos::GeomID &)
Function &	setZDomain (const ZDomain::Info &)
const UnitOfMeasure *	velUnit () const
const ZDomain::Info &	zDomain () const
bool	zInFeet () const
bool	zInMeter () const
bool	zIsTime () const
Public Member Functions inherited from RefCount::Referenced
void	addObserver (WeakPtrBase *obs)
	Not for normal use. May become private. More...
int	nrRefs () const
	Only for expert use. More...
void	ref () const
bool	refIfReffed () const
	Don't use in production, for debugging. More...
void	removeObserver (WeakPtrBase *obs)
	Not for normal use. May become private. More...
bool	tryRef () const
	Not for normal use. May become private. More...
void	unRef () const
void	unRefNoDelete () const

Protected Member Functions
virtual	~Function ()
virtual bool	computeVelocity (float z0, float dz, int sz, float *res) const =0
Function &	copyDescFrom (const FunctionSource &)
Pos::GeomID	geomid_ ()
Protected Member Functions inherited from RefCount::Referenced
	Referenced ()
	Referenced (const Referenced &)
virtual	~Referenced ()
Referenced &	operator= (const Referenced &)

Protected Attributes
BinID	bid_
StepInterval< float >	desiredrg_
FunctionSource &	source_

Private Member Functions
VelocityDesc &	desc_ ()
const ZDomain::Info *	zdomaininfo_ ()

Private Attributes
TypeSet< float > *	cache_ = nullptr
Threads::Lock	cachelock_
SamplingData< double >	cachesd_

Friends
class	FunctionSource

Additional Inherited Members
Static Public Member Functions inherited from RefCount::Referenced
static bool	isSane (const Referenced *)

Detailed Description

Velocity versus depth for one location. The source of information is different for each subclass, but is typically user-picks, wells or velocity volumes.

<>

Constructor & Destructor Documentation

Function()

Vel::Function::Function

(

FunctionSource &

)

~Function()

virtual Vel::Function::~Function ( )

protectedvirtual

Member Function Documentation

computeVelocity()

virtual bool Vel::Function::computeVelocity ( float  z0, float  dz, int  sz, float *  res  ) const

protectedpure virtual

Implemented in Vel::VolumeFunction, Vel::StoredFunction, Vel::IntervalFunction, and Vel::GriddedFunction.

copyDescFrom()

Function& Vel::Function::copyDescFrom ( const FunctionSource &  )

protected

desc_()

VelocityDesc& Vel::Function::desc_ ( )

private

geomid_()

Pos::GeomID Vel::Function::geomid_ ( )

protected

getAvailableZ()

virtual StepInterval<float> Vel::Function::getAvailableZ ( ) const

pure virtual

Implemented in Vel::VolumeFunction, Vel::StoredFunction, Vel::IntervalFunction, and Vel::GriddedFunction.

getBinID()

const BinID& Vel::Function::getBinID

(

)

const

getDesc()

virtual const VelocityDesc& Vel::Function::getDesc ( ) const

virtual

getDesiredZ()

const StepInterval<float>& Vel::Function::getDesiredZ

(

)

const

getGeomID()

Pos::GeomID Vel::Function::getGeomID

(

)

const

getSource()

const FunctionSource& Vel::Function::getSource ( ) const

inline

getVelocity()

float Vel::Function::getVelocity

(

float

z

)

const

moveTo()

virtual bool Vel::Function::moveTo ( const BinID &  )

virtual

Reimplemented in Vel::VolumeFunction, Vel::StoredFunction, Vel::IntervalFunction, and Vel::GriddedFunction.

removeCache()

virtual void Vel::Function::removeCache ( )

virtual

setDesiredZRange()

void Vel::Function::setDesiredZRange

(

const StepInterval< float > &

)

setGeomID()

void Vel::Function::setGeomID

(

const Pos::GeomID &

)

setZDomain()

Function& Vel::Function::setZDomain

(

const ZDomain::Info &

)

velUnit()

const UnitOfMeasure* Vel::Function::velUnit

(

)

const

zDomain()

const ZDomain::Info& Vel::Function::zDomain

(

)

const

zdomaininfo_()

const ZDomain::Info* Vel::Function::zdomaininfo_ ( )

private

zInFeet()

bool Vel::Function::zInFeet

(

)

const

zInMeter()

bool Vel::Function::zInMeter

(

)

const

zIsTime()

bool Vel::Function::zIsTime

(

)

const

Friends And Related Function Documentation

FunctionSource

friend class FunctionSource

friend

Member Data Documentation

bid_

BinID Vel::Function::bid_

protected

cache_

TypeSet<float>* Vel::Function::cache_ = nullptr

mutableprivate

cachelock_

Threads::Lock Vel::Function::cachelock_

mutableprivate

cachesd_

SamplingData<double> Vel::Function::cachesd_

mutableprivate

desiredrg_

StepInterval<float> Vel::Function::desiredrg_

protected

source_

FunctionSource& Vel::Function::source_

protected