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

#include <MeasureImplementation.h>

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

List of all members.

Public Member Functions
	Implementation ()
	This default constructor is for use by concrete measure implementation classes.
	Implementation (Stage dependsOn, Stage invalidated)
	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	setDependsOnStage (Stage dependsOn)
void	setInvalidatedStage (Stage invalidated)
Stage	getDependsOnStage () const
Stage	getInvalidatedStage () const
void	markAsValid (const State &state) const
bool	isValid (const State &state) const
void	markAsNotValid (const State &state) const
T &	updValue (const State &state) const
Implementation *	cloneVirtual () const override
int	getNumTimeDerivativesVirtual () const override
Stage	getDependsOnStageVirtual (int derivOrder) const override
	Cache value is available after its "depends on" stage has been realized; but all its derivatives are zero so are always available.
void	calcCachedValueVirtual (const State &, int derivOrder, T &value) const override
	Concrete measures must override this if the state cache is used for precalculated values or derivatives.

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

---

Constructor & Destructor Documentation

template<class T>

SimTK::Measure_< T >::Result::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 >::Result::Implementation::Implementation	(	Stage	dependsOn,
		Stage	invalidated
	)		[inline]

template<class T>

SimTK::Measure_< T >::Result::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 >::Result::Implementation::setDependsOnStage

(

Stage

dependsOn

)

[inline]

template<class T>

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

(

Stage

invalidated

)

[inline]

template<class T>

Stage SimTK::Measure_< T >::Result::Implementation::getDependsOnStage

(

)

const [inline]

template<class T>

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

(

)

const [inline]

template<class T>

void SimTK::Measure_< T >::Result::Implementation::markAsValid

(

const State &

state

)

const [inline]

template<class T>

bool SimTK::Measure_< T >::Result::Implementation::isValid

(

const State &

state

)

const [inline]

template<class T>

void SimTK::Measure_< T >::Result::Implementation::markAsNotValid

(

const State &

state

)

const [inline]

template<class T>

T& SimTK::Measure_< T >::Result::Implementation::updValue

(

const State &

state

)

const [inline]

template<class T>

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

(

)

const [inline, override, virtual]

Implements SimTK::AbstractMeasure::Implementation.

template<class T>

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

(

)

const [inline, override, virtual]

Reimplemented from SimTK::AbstractMeasure::Implementation.

template<class T>

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

(

int

derivOrder

)

const [inline, override, virtual]

Cache value is available after its "depends on" stage has been realized; but all its derivatives are zero so are always available.

Implements SimTK::AbstractMeasure::Implementation.

template<class T>

void SimTK::Measure_< T >::Result::Implementation::calcCachedValueVirtual	(	const State &	,
		int	derivOrder,
		T &	value
	)		const [inline, override, virtual]

Concrete measures must override this if the state cache is used for precalculated values or derivatives.

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

---

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

• MeasureImplementation.h