Measure_< T > Class Template Reference

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

#include <Measure.h>

Inheritance diagram for Measure_< T >:

List of all members.

Classes
class	Constant
	This creates a Measure whose value is a Topology-stage constant of any type T. More...
class	Differentiate
	This Measure operator returns the time derivative of its operand measure, or a numerical approximation of the time derivative if an analytic one is not available. More...
class	Implementation
	This is the base Implementation class for all Measures whose value type is known. More...
class	Integrate
class	Minimum
	This Measure tracks the minimum value attained by its source operand since the last initialize() call. More...
class	Minus
	This Measure is the difference of two Measures of the same type T. More...
class	One
	This creates a Measure::Constant whose value is always T(1) and can't be changed. More...
class	Plus
	This Measure is the sum of two Measures of the same type T. More...
class	SampleAndHold
	This is a Measure operator which, upon occurrence of a designated event, samples its source Measure and then holds its value in a discrete state variable until the next occurrence of the event. More...
class	Scale
	This Measure multiplies some other Measure by a Real scale factor. More...
class	Sinusoid
	This measure produces a sinusoidal function of time:. More...
class	Time
	This creates a Measure::Time whose value is always T(time). More...
class	Variable
	This creates a Measure whose value is a discrete State variable of any type T. More...
class	Zero
	This creates a Measure::Constant whose value is always T(0) and can't be changed. More...
Public Member Functions
	SimTK_MEASURE_HANDLE_PREAMBLE_ABSTRACT (Measure_, AbstractMeasure)
	This class is still abstract so we don't want it to allocate an Implementation object in its default constructor.
const T &	getValue (const State &s, int derivOrder=0) const
	Retrieve the Value of this Measure or one of its time derivatives, assuming the State has been realized to at least the required stage for the desired value, as reported by getValueDependence().
	SimTK_MEASURE_HANDLE_POSTSCRIPT (Measure_, AbstractMeasure)

---

Detailed Description

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

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

---

Member Function Documentation

const T& getValue	(	const State &	s,
		int	derivOrder = 0
	)			const [inline]

Retrieve the Value of this Measure or one of its time derivatives, assuming the State has been realized to at least the required stage for the desired value, as reported by getValueDependence().

If the stage is sufficient but the corresponding value has not yet been computed, it will be computed first with its value going into this State's cache so that subsequent calls do not require further computation.

References AbstractMeasure::getImpl(), and Implementation::getValue().

SimTK_MEASURE_HANDLE_POSTSCRIPT	(	Measure_< T >	,
		AbstractMeasure
	)

SimTK_MEASURE_HANDLE_PREAMBLE_ABSTRACT	(	Measure_< T >	,
		AbstractMeasure
	)

This class is still abstract so we don't want it to allocate an Implementation object in its default constructor.

---

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

• Measure.h