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

This Measure tracks the minimum value attained by its source operand since the last initialize() call. More...

#include <Measure.h>

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

List of all members.

Public Member Functions
	SimTK_MEASURE_HANDLE_PREAMBLE (Minimum, Measure_< T >)
	Minimum (Subsystem &sub, const Measure_< T > &source, const Measure_< T > &sourceDot)
void	setValue (State &s, const T &value) const
const Measure_< T > &	getSourceMeasure () const
const Measure_< T > &	getSourceDerivativeMeasure () const
Minimum &	setSourceMeasure (const Measure_< T > &s)
Minimum &	setSourceDerivativeMeasure (const Measure_< T > &sdot)
	SimTK_MEASURE_HANDLE_POSTSCRIPT (Minimum, Measure_< T >)

---

Detailed Description

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

This Measure tracks the minimum value attained by its source operand since the last initialize() call.

If the time derivative of the source operand is available, the measure will arrange to ensure precise isolation of the minimum values by defining a triggered event that watches for negative-to-positive sign changes of the derivative. Then if you output reporting data upon the occurrence of triggered events (as well as your regularly scheduled output) your data will include the precise minimum (to within a specifiable isolation time window).

Information available from this Measure:

• the current value (at the source's stage)
• the value at the start of the current step (Time stage)
• time of last change
• the DiscreteVariableIndex holding the previous value
• the CacheEntryIndex designated for the current/next value
• a reference to the source Measure

And if a source derivative is available

• the EventId of the minimum-trapping event if there is one
• the time derivative of the Minimum measure
• a reference to the source derivative Measure

The time derivative fdot of f(t)=min_t0_t(s(t')) where s is the source measure and t0 <= t' <= t is

      fdot(t) = s(t) < f(ti) && sdot(t) < 0 ? sdot(t) : 0
 

where ti is the time at the start of the current step.

At the start of a continuous interval, the updated value (if any) replaces the stored value.

---

Constructor & Destructor Documentation

template<class T>

SimTK::Measure_< T >::Minimum::Minimum	(	Subsystem &	sub,
		const Measure_< T > &	source,
		const Measure_< T > &	sourceDot
	)		[inline]

---

Member Function Documentation

template<class T>

SimTK::Measure_< T >::Minimum::SimTK_MEASURE_HANDLE_PREAMBLE	(	Minimum	,
		Measure_< T >
	)

template<class T>

void SimTK::Measure_< T >::Minimum::setValue	(	State &	s,
		const T &	value
	)		const [inline]

template<class T>

const Measure_<T>& SimTK::Measure_< T >::Minimum::getSourceMeasure

(

)

const [inline]

template<class T>

const Measure_<T>& SimTK::Measure_< T >::Minimum::getSourceDerivativeMeasure

(

)

const [inline]

template<class T>

Minimum& SimTK::Measure_< T >::Minimum::setSourceMeasure

(

const Measure_< T > &

s

)

[inline]

template<class T>

Minimum& SimTK::Measure_< T >::Minimum::setSourceDerivativeMeasure

(

const Measure_< T > &

sdot

)

[inline]

template<class T>

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

---

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

• Measure.h