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

Track the maximum value of the operand (signed). More...

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

Public Member Functions

 Maximum (Subsystem &sub, const Measure_< T > &operand)
- Public Member Functions inherited from SimTK::Measure_< T >::Extreme
 SimTK_MEASURE_HANDLE_PREAMBLE (Extreme, Measure_< T >)
 Extreme (Subsystem &sub, const Measure_< T > &operand, Operation op=MaxAbs)
 Default behavior for the Extreme measure is to find the operand's value that is of maximum absolute value. More...
ExtremesetOperation (Operation op)
 Set the operation to be performed. More...
Operation getOperation () const
 Return the operation currently being performed by this measure. More...
Real getTimeOfExtremeValue (const State &state) const
 Return the time at which the reported extreme value first occurred. More...
void setValue (State &s, const T &value) const
const Measure_< T > & getOperandMeasure () const
ExtremesetOperandMeasure (const Measure_< T > &s)
- Public Member Functions inherited from SimTK::Measure_< T >
 This class is still abstract so we don't want it to allocate an Implementation object in its default constructor. More...
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(). More...
Measure_setDefaultValue (const T &defaultValue)
 Change the default value associated with this Measure. More...
const T & getDefaultValue () const
 Obtain a reference to the default value associated with this Measure. More...
 SimTK_MEASURE_HANDLE_POSTSCRIPT (Measure_, AbstractMeasure)
- Public Member Functions inherited from SimTK::AbstractMeasure
 AbstractMeasure (Implementation *g=0)
 Provide an Implementation for this AbstractMeasure and bump its reference count. More...
 AbstractMeasure (Subsystem &, Implementation *g, const SetHandle &)
 Construct this handle with a given Implementation object (whose reference count will be bumped) and then let the given Subsystem adopt this Measure (which will again bump the Implementation's reference count, leaving us with two new handles). More...
 AbstractMeasure (const AbstractMeasure &)
 Shallow copy constructor copies the pointer from the source Implementation object and bumps its reference count. More...
AbstractMeasureoperator= (const AbstractMeasure &source)
 Shallow assignment operator results in this handle referencing the same Implementation object as does the source. More...
 ~AbstractMeasure ()
 Destructor decrements the Implementation's reference count and deletes the object if the count goes to zero. More...
AbstractMeasureshallowAssign (const AbstractMeasure &)
 Shallow assignment operator destructs the current Implementation object (meaning its reference count is decremented and the object actually deleted only if the count goes to zero), then copies the Implementation pointer from the source and bumps its reference count. More...
AbstractMeasuredeepAssign (const AbstractMeasure &source)
 Deep assignment clones the Implementation object pointed to by the source handle, so that this handle ends up pointing to a new Measure object similar to the original but not yet contained in any Subsystem. More...
int getNumTimeDerivatives () const
 Every Measure can produce a value, and some can provide one or more total derivatives with respect to time of that value. More...
Stage getDependsOnStage (int derivOrder=0) const
 At what Stage can we expect the value of this AbstractMeasure or one of its time derivatives to be available? Users of Measures will typically impose restrictions on the levels they will accept. More...
bool isSameMeasure (const AbstractMeasure &other) const
 There can be multiple handles on the same Measure. More...
bool isEmptyHandle () const
bool isInSubsystem () const
 Test whether this Measure object has been adopted by a Subsystem. More...
const SubsystemgetSubsystem () const
 Return a reference to the Subsystem that owns this Measure. More...
bool isSameSubsystem (const Subsystem &) const
 Is getSubsystem() the same as the passed-in Subsystem? More...
MeasureIndex getSubsystemMeasureIndex () const
 Return the MeasureIndex by which this Measure is known to the Subsystem that owns it. More...
const ImplementationgetImpl () const
ImplementationupdImpl ()
bool hasImpl () const
int getRefCount () const

Detailed Description

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

Track the maximum value of the operand (signed).

See also

Constructor & Destructor Documentation

◆ Maximum()

template<class T>
SimTK::Measure_< T >::Maximum::Maximum ( Subsystem sub,
const Measure_< T > &  operand 

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