Simbody
Public Member Functions | Protected Member Functions | Static Protected Member Functions

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

This is the base Implementation class for all Measures whose value type is known. More...

#include <MeasureImplementation.h>

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

List of all members.

Public Member Functions

const T & getValue (const State &s, int derivOrder) const
void setIsPresumedValidAtDependsOnStage (bool presume)
bool getIsPresumedValidAtDependsOnStage () const

Protected Member Functions

 Implementation (int numValues=1)
 Implementation (const Implementation &source)
void realizeTopology (State &s) const
int getNumCacheEntries () const
const T & getCacheEntry (const State &s, int derivOrder) const
T & updCacheEntry (const State &s, int derivOrder) const
bool isCacheValueRealized (const State &s, int derivOrder) const
void markCacheValueRealized (const State &s, int derivOrder) const
void markCacheValueNotRealized (const State &s, int derivOrder) const
virtual void realizeMeasureTopologyVirtual (State &) const
virtual void calcCachedValueVirtual (const State &, int derivOrder, T &value) const
virtual const T & getUncachedValueVirtual (const State &, int derivOrder) const

Static Protected Member Functions

static const T & getValueZero ()
static const T & getValueOne ()

Detailed Description

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

This is the base Implementation class for all Measures whose value type is known.

This class is still abstract but provides many services related to the values of the derived Measure and its derivatives, all of which require cache entries of type T.

The constructor needs to be told how many type-T cache entries to allocate.


Constructor & Destructor Documentation

template<class T>
SimTK::Measure_< T >::Implementation::Implementation ( int  numValues = 1) [inline, explicit, protected]
template<class T>
SimTK::Measure_< T >::Implementation::Implementation ( const Implementation source) [inline, protected]

Member Function Documentation

template<class T>
const T& SimTK::Measure_< T >::Implementation::getValue ( const State s,
int  derivOrder 
) const [inline]
template<class T>
void SimTK::Measure_< T >::Implementation::setIsPresumedValidAtDependsOnStage ( bool  presume) [inline]
template<class T>
bool SimTK::Measure_< T >::Implementation::getIsPresumedValidAtDependsOnStage ( ) const [inline]
template<class T>
void SimTK::Measure_< T >::Implementation::realizeTopology ( State s) const [inline, protected, virtual]
template<class T>
int SimTK::Measure_< T >::Implementation::getNumCacheEntries ( ) const [inline, protected]
template<class T>
const T& SimTK::Measure_< T >::Implementation::getCacheEntry ( const State s,
int  derivOrder 
) const [inline, protected]
template<class T>
T& SimTK::Measure_< T >::Implementation::updCacheEntry ( const State s,
int  derivOrder 
) const [inline, protected]
template<class T>
bool SimTK::Measure_< T >::Implementation::isCacheValueRealized ( const State s,
int  derivOrder 
) const [inline, protected]
template<class T>
void SimTK::Measure_< T >::Implementation::markCacheValueRealized ( const State s,
int  derivOrder 
) const [inline, protected]
template<class T>
void SimTK::Measure_< T >::Implementation::markCacheValueNotRealized ( const State s,
int  derivOrder 
) const [inline, protected]
template<class T>
virtual void SimTK::Measure_< T >::Implementation::realizeMeasureTopologyVirtual ( State ) const [inline, protected, virtual]
template<class T>
virtual void SimTK::Measure_< T >::Implementation::calcCachedValueVirtual ( const State ,
int  derivOrder,
T &  value 
) const [inline, protected, virtual]
template<class T>
virtual const T& SimTK::Measure_< T >::Implementation::getUncachedValueVirtual ( const State ,
int  derivOrder 
) const [inline, protected, virtual]
template<class T>
static const T& SimTK::Measure_< T >::Implementation::getValueZero ( ) [inline, static, protected]
template<class T>
static const T& SimTK::Measure_< T >::Implementation::getValueOne ( ) [inline, static, protected]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines