SimTK::Measure_< T >::Variable::Implementation Class Reference

#include <MeasureImplementation.h>

Inheritance diagram for SimTK::Measure_< T >::Variable::Implementation:

List of all members.

Public Member Functions
	Implementation ()
	This default constructor is for use by concrete measure implementation classes.
	Implementation (Stage invalidated, const T &defaultValue)
	Implementation (const Implementation &source)
	Copy constructor copies the number of cache entries from the source, but not the cache indices themselves as those must be allocated uniquely for the copy.
void	setInvalidatedStage (Stage invalidates)
Stage	getInvalidatedStage () const
void	setValue (State &state, const T &value) const
	Change the value of this Measure in the given state.
Implementation *	cloneVirtual () const override
int	getNumTimeDerivativesVirtual () const override
Stage	getDependsOnStageVirtual (int derivOrder) const override
const T &	getUncachedValueVirtual (const State &s, int derivOrder) const override
	This is only called when derivOrder >= the number of cache entries we have, but still <= the number of derivatives the Measure says it can deliver.
void	realizeMeasureTopologyVirtual (State &s) const override
	Concrete measures can override this to allocate Topology-stage resources.

template<class T>
class SimTK::Measure_< T >::Variable::Implementation

---

Constructor & Destructor Documentation

template<class T>

SimTK::Measure_< T >::Variable::Implementation::Implementation

(

)

[inline]

This default constructor is for use by concrete measure implementation classes.

Reimplemented from SimTK::AbstractMeasure::Implementation.

template<class T>

SimTK::Measure_< T >::Variable::Implementation::Implementation	(	Stage	invalidated,
		const T &	defaultValue
	)		[inline]

template<class T>

SimTK::Measure_< T >::Variable::Implementation::Implementation

(

const Implementation &

source

)

[inline]

Copy constructor copies the number of cache entries from the source, but not the cache indices themselves as those must be allocated uniquely for the copy.

Reimplemented from SimTK::Measure_< T >::Implementation.

---

Member Function Documentation

template<class T>

void SimTK::Measure_< T >::Variable::Implementation::setInvalidatedStage

(

Stage

invalidates

)

[inline]

template<class T>

Stage SimTK::Measure_< T >::Variable::Implementation::getInvalidatedStage

(

)

const [inline]

template<class T>

void SimTK::Measure_< T >::Variable::Implementation::setValue	(	State &	state,
		const T &	value
	)		const [inline]

Change the value of this Measure in the given state.

Invalidates cache entries in that state for any stage at or above the "invalidates" stage that was set when this Measure was constructed.

template<class T>

Implementation* SimTK::Measure_< T >::Variable::Implementation::cloneVirtual

(

)

const [inline, override, virtual]

Implements SimTK::AbstractMeasure::Implementation.

template<class T>

int SimTK::Measure_< T >::Variable::Implementation::getNumTimeDerivativesVirtual

(

)

const [inline, override, virtual]

Reimplemented from SimTK::AbstractMeasure::Implementation.

template<class T>

Stage SimTK::Measure_< T >::Variable::Implementation::getDependsOnStageVirtual

(

int

derivOrder

)

const [inline, override, virtual]

Implements SimTK::AbstractMeasure::Implementation.

template<class T>

const T& SimTK::Measure_< T >::Variable::Implementation::getUncachedValueVirtual	(	const State &	,
		int	derivOrder
	)		const [inline, override, virtual]

This is only called when derivOrder >= the number of cache entries we have, but still <= the number of derivatives the Measure says it can deliver.

You don't need to override this if that condition can't occur. This is commonly used for functions whose derivatives above a certain order are zero.

Reimplemented from SimTK::Measure_< T >::Implementation.

template<class T>

void SimTK::Measure_< T >::Variable::Implementation::realizeMeasureTopologyVirtual

(

State &

)

const [inline, override, virtual]

Concrete measures can override this to allocate Topology-stage resources.

Reimplemented from SimTK::Measure_< T >::Implementation.

---

The documentation for this class was generated from the following file:

• MeasureImplementation.h