SimTK::Measure_< T > Class Template Reference

This is the base handle class for all Measures whose value type is known, including all the Simbody built-in Measure types. More...

#include <Measure.h>

Inheritance diagram for SimTK::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	Delay
	(CAUTION: still under development) This is a Measure whose value at time t is the value that its source operand had at time t-delay for a specified delay. 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	Extreme
	This Measure tracks extreme values attained by the elements of its source operand since the last initialize() call or explicit call to setValue(). More...
class	Implementation
	This is the base Implementation class for all Measures whose value type is known. More...
class	Integrate
	This measure yields the time integral of a given derivative measure, initializing with an initial condition measure of the same type T. More...
class	MaxAbs
	Track the value of the operand that is of maximum absolute value. More...
class	Maximum
	Track the maximum value of the operand (signed). More...
class	MinAbs
	Track the value of the operand that is of minimum absolute value (not very useful). More...
class	Minimum
	Track the minimum value of the operand (signed). 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	Result
	This Measure holds the result of some externally-determined computation, and helps to coordinate the validity of that computation with respect to the state variables. More...
class	SampleAndHold
	NOT IMPLEMENTED YET -- 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 supplied State has been realized to at least the required stage for the selected value or derivative, as reported by getDependsOnStage().
Measure_ &	setDefaultValue (const T &defaultValue)
	Change the default value associated with this Measure.
const T &	getDefaultValue () const
	Obtain a reference to the default value associated with this Measure.
	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, including all the Simbody built-in Measure types.

---

Member Function Documentation

template<class T>

SimTK::Measure_< T >::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.

template<class T>

const T& SimTK::Measure_< T >::getValue	(	const State &	s,
		int	derivOrder = 0
	)		const [inline]

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

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.

template<class T>

Measure_& SimTK::Measure_< T >::setDefaultValue

(

const T &

defaultValue

)

[inline]

Change the default value associated with this Measure.

How this is used varies with the Measure type but generally it is the value that the Measure will have before any calculations are performed. Note that this does not require a State since it is a Topology-stage change; you have to call realizeTopology() again if you call this method.

template<class T>

const T& SimTK::Measure_< T >::getDefaultValue

(

)

const [inline]

Obtain a reference to the default value associated with this Measure.

template<class T>

SimTK::Measure_< T >::SimTK_MEASURE_HANDLE_POSTSCRIPT	(	Measure_< T >	,
		AbstractMeasure
	)

---

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

• Measure.h