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

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

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

Public Member Functions

const T & getValue (const State &s, int derivOrder) const
 
void setDefaultValue (const T &defaultValue)
 Set a new default value for this Measure. More...
 
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(). More...
 
void setIsPresumedValidAtDependsOnStage (bool presume)
 
bool getIsPresumedValidAtDependsOnStage () const
 

Protected Member Functions

 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. More...
 
 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. More...
 
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. More...
 
int getNumCacheEntries () const
 Return the number of cache entries allocated for the value and derivatives of this Measure. More...
 
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). More...
 
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). More...
 
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. More...
 
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. More...
 
void markCacheValueNotRealized (const State &s, int derivOrder) const
 Invalidate one of this Measure's cache entries. More...
 
virtual void realizeMeasureTopologyVirtual (State &) const
 Concrete measures can override this to allocate Topology-stage resources. More...
 
virtual void calcCachedValueVirtual (const State &, int derivOrder, T &value) const
 Concrete measures must override this if the state cache is used for precalculated values or derivatives. More...
 
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. More...
 
const T & getValueZero () const
 Return a reference to a zero of the same type and size as this Measure's value. More...
 
- Protected Member Functions inherited from SimTK::AbstractMeasure::Implementation
 Implementation ()
 This default constructor is for use by concrete measure implementation classes. More...
 
 Implementation (const Implementation &src)
 Base class copy constructor removes the Subsystem and sets the reference count to zero. More...
 
Implementationoperator= (const Implementation &src)
 Base class copy assignment operator removes the Subsystem, and sets the reference count to zero. More...
 
int incrRefCount () const
 
int decrRefCount () const
 
int getRefCount () const
 
int getCopyNumber () const
 
Implementationclone () const
 This is a deep copy of the concrete Implementation object, except the Subsystem will have been removed. More...
 
void realizeModel (State &s) const
 
void realizeInstance (const State &s) const
 
void realizeTime (const State &s) const
 
void realizePosition (const State &s) const
 
void realizeVelocity (const State &s) const
 
void realizeDynamics (const State &s) const
 
void realizeAcceleration (const State &s) const
 
void realizeReport (const State &s) const
 
void initialize (State &s) const
 This should be called at the start of a time stepping study to cause this Measure to set its state variables (if any) in the supplied state to their initial conditions. More...
 
int getNumTimeDerivatives () const
 
Stage getDependsOnStage (int derivOrder) const
 
void setSubsystem (Subsystem &sub, MeasureIndex mx)
 
bool isInSubsystem () const
 
const SubsystemgetSubsystem () const
 
SubsystemupdSubsystem ()
 
MeasureIndex getSubsystemMeasureIndex () const
 
SubsystemIndex getSubsystemIndex () const
 
void invalidateTopologyCache () const
 
Stage getStage (const State &s) const
 
virtual ~Implementation ()
 
virtual ImplementationcloneVirtual () const =0
 
virtual void realizeMeasureModelVirtual (State &) const
 
virtual void realizeMeasureInstanceVirtual (const State &) const
 
virtual void realizeMeasureTimeVirtual (const State &) const
 
virtual void realizeMeasurePositionVirtual (const State &) const
 
virtual void realizeMeasureVelocityVirtual (const State &) const
 
virtual void realizeMeasureDynamicsVirtual (const State &) const
 
virtual void realizeMeasureAccelerationVirtual (const State &) const
 
virtual void realizeMeasureReportVirtual (const State &) const
 
virtual void initializeVirtual (State &) const
 
virtual int getNumTimeDerivativesVirtual () const
 
virtual Stage getDependsOnStageVirtual (int order) const =0
 

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

◆ Implementation() [1/3]

template<class T>
SimTK::Measure_< T >::Implementation::Implementation ( const T &  defaultValue,
int  numCacheEntries = 1 
)
inlineexplicitprotected

◆ Implementation() [2/3]

template<class T>
SimTK::Measure_< T >::Implementation::Implementation ( int  numCacheEntries = 1)
inlineexplicitprotected

Argument numCacheEntries should be one greater than the number of derivatives; that is, there is room for the value ("0th" derivative) also.

The default is to allocate just room for the value.

◆ Implementation() [3/3]

template<class T>
SimTK::Measure_< T >::Implementation::Implementation ( const Implementation source)
inlineprotected

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.

Member Function Documentation

◆ getValue()

template<class T>
const T& SimTK::Measure_< T >::Implementation::getValue ( const State s,
int  derivOrder 
) const
inline

◆ setDefaultValue()

template<class T>
void SimTK::Measure_< T >::Implementation::setDefaultValue ( const T &  defaultValue)
inline

Set a new default value for this Measure.

This is a topological change.

◆ getDefaultValue()

template<class T>
const T& SimTK::Measure_< T >::Implementation::getDefaultValue ( ) const
inline

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().

◆ setIsPresumedValidAtDependsOnStage()

template<class T>
void SimTK::Measure_< T >::Implementation::setIsPresumedValidAtDependsOnStage ( bool  presume)
inline

◆ getIsPresumedValidAtDependsOnStage()

template<class T>
bool SimTK::Measure_< T >::Implementation::getIsPresumedValidAtDependsOnStage ( ) const
inline

◆ size()

template<class T>
int SimTK::Measure_< T >::Implementation::size ( ) const
inlineprotected

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.

◆ getNumCacheEntries()

template<class T>
int SimTK::Measure_< T >::Implementation::getNumCacheEntries ( ) const
inlineprotected

Return the number of cache entries allocated for the value and derivatives of this Measure.

◆ getCacheEntry()

template<class T>
const T& SimTK::Measure_< T >::Implementation::getCacheEntry ( const State s,
int  derivOrder 
) const
inlineprotected

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).

◆ updCacheEntry()

template<class T>
T& SimTK::Measure_< T >::Implementation::updCacheEntry ( const State s,
int  derivOrder 
) const
inlineprotected

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).

◆ isCacheValueRealized()

template<class T>
bool SimTK::Measure_< T >::Implementation::isCacheValueRealized ( const State s,
int  derivOrder 
) const
inlineprotected

Determine whether a particular one of this Measure's cache entries has already been realized since the given state was modified.

◆ markCacheValueRealized()

template<class T>
void SimTK::Measure_< T >::Implementation::markCacheValueRealized ( const State s,
int  derivOrder 
) const
inlineprotected

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.

◆ markCacheValueNotRealized()

template<class T>
void SimTK::Measure_< T >::Implementation::markCacheValueNotRealized ( const State s,
int  derivOrder 
) const
inlineprotected

Invalidate one of this Measure's cache entries.

This is not normally necessary since the cache entries will be invalidated automatically when state variables they depend on change. However, this can be useful in some cases, particularly during debugging and testing.

◆ realizeMeasureTopologyVirtual()

template<class T>
virtual void SimTK::Measure_< T >::Implementation::realizeMeasureTopologyVirtual ( State ) const
inlineprotectedvirtual

◆ calcCachedValueVirtual()

template<class T>
virtual void SimTK::Measure_< T >::Implementation::calcCachedValueVirtual ( const State ,
int  derivOrder,
T &  value 
) const
inlineprotectedvirtual

◆ getUncachedValueVirtual()

template<class T>
virtual const T& SimTK::Measure_< T >::Implementation::getUncachedValueVirtual ( const State ,
int  derivOrder 
) const
inlineprotectedvirtual

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 in SimTK::Measure_< T >::Extreme::Implementation, SimTK::Measure_< T >::Differentiate::Implementation, SimTK::Measure_< T >::Integrate::Implementation, SimTK::Measure_< T >::Variable::Implementation, SimTK::Measure_< T >::Time::Implementation, and SimTK::Measure_< T >::Constant::Implementation.

◆ getValueZero()

template<class T>
const T& SimTK::Measure_< T >::Implementation::getValueZero ( ) const
inlineprotected

Return a reference to a zero of the same type and size as this Measure's value.


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