#include <MeasureImplementation.h>

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

Public Member Functions
	Implementation ()
	Default constructor leaves the operand measure unspecified; no base class cache entries are allocated.

	Implementation (const Measure_< T > &operand, Operation op)
	Construct a measure that returns the extreme value taken on by the operand measure during a time stepping study.

void	setOperandMeasure (const Measure_< T > &operand)
	Set the operand measure for this Extreme measure; this is a Topology stage change so you'll have to call realizeTopology() again if you call this.

void	setOperation (Operation op)
	Set the particular operation to be performed by this Extreme measure; this is a Topology stage change so you'll have to call realizeTopology() again if you call this.

const Measure_< T > &	getOperandMeasure () const
	Return a reference to the operand measure for this Extreme measure.

Operation	getOperation () const
	Return the particular operation being performed by this Extreme measure.

void	setValue (State &s, const T &value) const
	Set the current extreme value stored in this Extreme measure's state variable.

Real	getTimeOfExtremeValue (const State &s) const
	Return the time at which the extreme was last updated.

Implementation *	cloneVirtual () const override

int	getNumTimeDerivativesVirtual () const override
	Extreme(f(t)) has the same number of derivatives as f except that they are all zero unless f(t) is a new extreme.

Stage	getDependsOnStageVirtual (int order) const override
	The depends-on stage for this measure is the same as for its operand.

const T &	getUncachedValueVirtual (const State &s, int derivOrder) const override
	We're not using the Measure_<T> base class cache services, but we do have one of our own.

void	initializeVirtual (State &s) const override
	At start of a time stepping study, this should be called to set the current extreme value to the current value of the operand.

void	realizeMeasureTopologyVirtual (State &s) const override
	Allocate the auto-updated state variable that holds the extreme seen so far.

void	realizeMeasureAccelerationVirtual (const State &s) const override
	In case no one has updated the value of this measure yet, we have to make sure it gets updated before the integration moves ahead.

bool	ensureExtremeHasBeenUpdated (const State &s) const
	Here we make sure that the cache entry is updated if the current value of the operand is more extreme than the previous one, and return a bool indicating whether we have a new extreme.

Public Member Functions inherited from SimTK::Measure_< T >::Implementation
const T &	getValue (const State &s, int derivOrder) const

void	setDefaultValue (const T &defaultValue)
	Set a new default value for this Measure.

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

void	setIsPresumedValidAtDependsOnStage (bool presume)

bool	getIsPresumedValidAtDependsOnStage () const

Additional Inherited Members
Protected Member Functions inherited from SimTK::Measure_< T >::Implementation
	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.

	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.

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.

int	getNumCacheEntries () const
	Return the number of cache entries allocated for the value and derivatives of this Measure.

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

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

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.

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.

void	markCacheValueNotRealized (const State &s, int derivOrder) const
	Invalidate one of this Measure's cache entries.

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.

const T &	getValueZero () const
	Return a reference to a zero of the same type and size as this Measure's value.

Protected Member Functions inherited from SimTK::AbstractMeasure::Implementation
	Implementation ()
	This default constructor is for use by concrete measure implementation classes.

	Implementation (const Implementation &src)
	Base class copy constructor removes the Subsystem and sets the reference count to zero.

Implementation &	operator= (const Implementation &src)
	Base class copy assignment operator removes the Subsystem, and sets the reference count to zero.

int	incrRefCount () const

int	decrRefCount () const

int	getRefCount () const

int	getCopyNumber () const

Implementation *	clone () const
	This is a deep copy of the concrete Implementation object, except the Subsystem will have been removed.

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.

int	getNumTimeDerivatives () const

Stage	getDependsOnStage (int derivOrder) const

void	setSubsystem (Subsystem &sub, MeasureIndex mx)

bool	isInSubsystem () const

const Subsystem &	getSubsystem () const

Subsystem &	updSubsystem ()

MeasureIndex	getSubsystemMeasureIndex () const

SubsystemIndex	getSubsystemIndex () const

void	invalidateTopologyCache () const

Stage	getStage (const State &s) const

virtual	~Implementation ()

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	realizeMeasureReportVirtual (const State &) const

Constructor & Destructor Documentation

◆ Implementation() [1/2]

template<class T >

SimTK::Measure_< T >::Extreme::Implementation::Implementation ( )

inline

Default constructor leaves the operand measure unspecified; no base class cache entries are allocated.

◆ Implementation() [2/2]

template<class T >

SimTK::Measure_< T >::Extreme::Implementation::Implementation	(	const Measure_< T > &	operand,
		Operation	op
	)

inline

Construct a measure that returns the extreme value taken on by the operand measure during a time stepping study.

Member Function Documentation

◆ setOperandMeasure()

template<class T >

void SimTK::Measure_< T >::Extreme::Implementation::setOperandMeasure ( const Measure_< T > & operand )

inline

Set the operand measure for this Extreme measure; this is a Topology stage change so you'll have to call realizeTopology() again if you call this.

◆ setOperation()

template<class T >

void SimTK::Measure_< T >::Extreme::Implementation::setOperation ( Operation op )

inline

Set the particular operation to be performed by this Extreme measure; this is a Topology stage change so you'll have to call realizeTopology() again if you call this.

◆ getOperandMeasure()

template<class T >

const Measure_< T > & SimTK::Measure_< T >::Extreme::Implementation::getOperandMeasure ( ) const

inline

Return a reference to the operand measure for this Extreme measure.

◆ getOperation()

template<class T >

Operation SimTK::Measure_< T >::Extreme::Implementation::getOperation ( ) const

inline

Return the particular operation being performed by this Extreme measure.

◆ setValue()

template<class T >

void SimTK::Measure_< T >::Extreme::Implementation::setValue	(	State &	s,
		const T &	value
	)		const

inline

Set the current extreme value stored in this Extreme measure's state variable.

◆ getTimeOfExtremeValue()

template<class T >

Real SimTK::Measure_< T >::Extreme::Implementation::getTimeOfExtremeValue ( const State & s ) const

inline

Return the time at which the extreme was last updated.

This will be the current time if the operand is currently at its most extreme value, otherwise it will be sometime in the past.

◆ cloneVirtual()

template<class T >

Implementation * SimTK::Measure_< T >::Extreme::Implementation::cloneVirtual ( ) const

inlineoverridevirtual

Implements SimTK::AbstractMeasure::Implementation.

◆ getNumTimeDerivativesVirtual()

template<class T >

int SimTK::Measure_< T >::Extreme::Implementation::getNumTimeDerivativesVirtual ( ) const

inlineoverridevirtual

Extreme(f(t)) has the same number of derivatives as f except that they are all zero unless f(t) is a new extreme.

Reimplemented from SimTK::AbstractMeasure::Implementation.

◆ getDependsOnStageVirtual()

template<class T >

Stage SimTK::Measure_< T >::Extreme::Implementation::getDependsOnStageVirtual ( int order ) const

inlineoverridevirtual

The depends-on stage for this measure is the same as for its operand.

Implements SimTK::AbstractMeasure::Implementation.

◆ getUncachedValueVirtual()

template<class T >

const T & SimTK::Measure_< T >::Extreme::Implementation::getUncachedValueVirtual	(	const State &	s,
		int	derivOrder
	)		const

inlineoverridevirtual

We're not using the Measure_<T> base class cache services, but we do have one of our own.

It looks uncached from the base class point of view which is why we're implementing it here.

Reimplemented from SimTK::Measure_< T >::Implementation.

◆ initializeVirtual()

template<class T >

void SimTK::Measure_< T >::Extreme::Implementation::initializeVirtual ( State & s ) const

inlineoverridevirtual

At start of a time stepping study, this should be called to set the current extreme value to the current value of the operand.

Reimplemented from SimTK::AbstractMeasure::Implementation.

◆ realizeMeasureTopologyVirtual()

template<class T >

void SimTK::Measure_< T >::Extreme::Implementation::realizeMeasureTopologyVirtual ( State & s ) const

inlineoverridevirtual

Allocate the auto-updated state variable that holds the extreme seen so far.

We'll assume that changes to this variable invalidate Dynamics (force) stage so that any forces that depend on it will be recomputed if it changes. Also allocate an auxiliary boolean variable that is used to hold whether the current value is a new extreme; that is private to the implementation and not user-accessible since you can instead check the time of last update.

Reimplemented from SimTK::Measure_< T >::Implementation.

◆ realizeMeasureAccelerationVirtual()

template<class T >

void SimTK::Measure_< T >::Extreme::Implementation::realizeMeasureAccelerationVirtual ( const State & s ) const

inlineoverridevirtual

In case no one has updated the value of this measure yet, we have to make sure it gets updated before the integration moves ahead.

Reimplemented from SimTK::AbstractMeasure::Implementation.

◆ ensureExtremeHasBeenUpdated()

template<class T >

bool SimTK::Measure_< T >::Extreme::Implementation::ensureExtremeHasBeenUpdated ( const State & s ) const

inline

Here we make sure that the cache entry is updated if the current value of the operand is more extreme than the previous one, and return a bool indicating whether we have a new extreme.

We don't want to create an update entry unless the extreme value has changed, because we would like the state variable's last update value to reflect the last actual change.

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

MeasureImplementation.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ Implementation() [1/2]

◆ Implementation() [2/2]

Member Function Documentation

◆ setOperandMeasure()

◆ setOperation()

◆ getOperandMeasure()

◆ getOperation()

◆ setValue()

◆ getTimeOfExtremeValue()

◆ cloneVirtual()

◆ getNumTimeDerivativesVirtual()

◆ getDependsOnStageVirtual()

◆ getUncachedValueVirtual()

◆ initializeVirtual()

◆ realizeMeasureTopologyVirtual()

◆ realizeMeasureAccelerationVirtual()

◆ ensureExtremeHasBeenUpdated()