#include <MeasureImplementation.h>

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

Public Member Functions
	Implementation ()
	This default constructor is for use by concrete measure implementation classes.
	Implementation (const Measure_< T > &source, Real delay)
void	setSourceMeasure (const Measure_< T > &source)
void	setDelay (Real delay)
void	setUseLinearInterpolationOnly (bool linearOnly)
void	setCanUseCurrentValue (bool canUseCurrentValue)
const Measure_< T > &	getSourceMeasure () const
Real	getDelay () const
bool	getUseLinearInterpolationOnly () const
bool	getCanUseCurrentValue () const
Implementation *	cloneVirtual () const override
int	getNumTimeDerivativesVirtual () const override
Stage	getDependsOnStageVirtual (int order) const override
void	calcCachedValueVirtual (const State &s, int derivOrder, T &value) const override
	Concrete measures must override this if the state cache is used for precalculated values or derivatives.
void	initializeVirtual (State &s) const override
void	realizeMeasureTopologyVirtual (State &s) const override
	Concrete measures can override this to allocate Topology-stage resources.
void	realizeMeasureAccelerationVirtual (const State &s) const override
	In case no one has updated the value of this measure yet, we have to make sure it gets updated before the integration moves ahead.
void	updateBuffer (const State &s) const
Public Member Functions inherited from SimTK::Measure_< T >::Implementation
const T &	getValue (const State &s, int derivOrder) const
void	setDefaultValue (const T &defaultValue)
	Set a new default value for this Measure.
const T &	getDefaultValue () const
	Return a reference to the value that this Measure will use to initialize its value-level state resource (state variable or cache entry) during the next call to realizeTopology().
void	setIsPresumedValidAtDependsOnStage (bool presume)
bool	getIsPresumedValidAtDependsOnStage () const

Additional Inherited Members
Protected Member Functions inherited from SimTK::Measure_< T >::Implementation
	Implementation (const T &defaultValue, int numCacheEntries=1)
	Implementation (int numCacheEntries=1)
	Argument numCacheEntries should be one greater than the number of derivatives; that is, there is room for the value ("0th" derivative) also.
	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.
int	size () const
	Return the number of elements in the data type of this Measure; for Vector measures this is determined by the size of the default value.
int	getNumCacheEntries () const
	Return the number of cache entries allocated for the value and derivatives of this Measure.
const T &	getCacheEntry (const State &s, int derivOrder) const
	Get a const reference to the value stored in one of this Measure's cache entries, indexed by the derivative order (with the value treated as the 0th derivative).
T &	updCacheEntry (const State &s, int derivOrder) const
	Get a writable reference to the value stored in one of this Measure's cache entries, indexed by the derivative order (with the value treated as the 0th derivative).
bool	isCacheValueRealized (const State &s, int derivOrder) const
	Determine whether a particular one of this Measure's cache entries has already been realized since the given state was modified.
void	markCacheValueRealized (const State &s, int derivOrder) const
	Mark one of this Measure's cache entries up to date; call this after you have calculated a value or derivative and stored it in the corresponding cache entry.
void	markCacheValueNotRealized (const State &s, int derivOrder) const
	Invalidate one of this Measure's cache entries.
virtual const T &	getUncachedValueVirtual (const State &, int derivOrder) const
	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.
const T &	getValueZero () const
	Return a reference to a zero of the same type and size as this Measure's value.

Constructor & Destructor Documentation

template<class T>

SimTK::Measure_< T >::Delay::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 >::Delay::Implementation::Implementation	(	const Measure_< T > &	source,
		Real	delay
	)

inline

Member Function Documentation

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::setSourceMeasure ( const Measure_< T > & source )

inline

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::setDelay ( Real delay )

inline

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::setUseLinearInterpolationOnly ( bool linearOnly )

inline

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::setCanUseCurrentValue ( bool canUseCurrentValue )

inline

template<class T>

const Measure_<T>& SimTK::Measure_< T >::Delay::Implementation::getSourceMeasure ( ) const

inline

template<class T>

Real SimTK::Measure_< T >::Delay::Implementation::getDelay ( ) const

inline

template<class T>

bool SimTK::Measure_< T >::Delay::Implementation::getUseLinearInterpolationOnly ( ) const

inline

template<class T>

bool SimTK::Measure_< T >::Delay::Implementation::getCanUseCurrentValue ( ) const

inline

template<class T>

Implementation* SimTK::Measure_< T >::Delay::Implementation::cloneVirtual ( ) const

inlineoverridevirtual

Implements SimTK::AbstractMeasure::Implementation.

template<class T>

int SimTK::Measure_< T >::Delay::Implementation::getNumTimeDerivativesVirtual ( ) const

inlineoverridevirtual

Reimplemented from SimTK::AbstractMeasure::Implementation.

template<class T>

Stage SimTK::Measure_< T >::Delay::Implementation::getDependsOnStageVirtual ( int order ) const

inlineoverridevirtual

Implements SimTK::AbstractMeasure::Implementation.

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::calcCachedValueVirtual	(	const State &	,
		int	derivOrder,
		T &	value
	)		const

inlineoverridevirtual

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

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

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::initializeVirtual ( State & s ) const

inlineoverridevirtual

Reimplemented from SimTK::AbstractMeasure::Implementation.

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::realizeMeasureTopologyVirtual ( State & ) const

inlineoverridevirtual

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

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

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::realizeMeasureAccelerationVirtual ( const State & s ) const

inlineoverridevirtual

In case no one has updated the value of this measure yet, we have to make sure it gets updated before the integration moves ahead.

Reimplemented from SimTK::AbstractMeasure::Implementation.

template<class T>

void SimTK::Measure_< T >::Delay::Implementation::updateBuffer ( const State & s ) const

inline

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

MeasureImplementation.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation