Simbody  3.5
Protected Member Functions | Friends | List of all members
SimTK::AbstractMeasure::Implementation Class Referenceabstract

The abstract parent of all Measure Implementation classes. More...

+ Inheritance diagram for SimTK::AbstractMeasure::Implementation:

Protected Member Functions

 Implementation ()
 This default constructor is for use by concrete measure implementation classes. More...
 
 Implementation (const Implementation &src)
 Base class copy constructor removes the Subsystem and sets the reference count to zero. More...
 
Implementation & operator= (const Implementation &src)
 Base class copy assignment operator removes the Subsystem, and sets the reference count to zero. More...
 
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. More...
 
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. More...
 
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 Implementation * cloneVirtual () const =0
 
virtual void realizeTopology (State &) const =0
 
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 realizeMeasureAccelerationVirtual (const State &) const
 
virtual void realizeMeasureReportVirtual (const State &) const
 
virtual void initializeVirtual (State &) const
 
virtual int getNumTimeDerivativesVirtual () const
 
virtual Stage getDependsOnStageVirtual (int order) const =0
 

Friends

class AbstractMeasure
 
class Subsystem::Guts
 

Detailed Description

The abstract parent of all Measure Implementation classes.

Constructor & Destructor Documentation

SimTK::AbstractMeasure::Implementation::Implementation ( )
inlineprotected

This default constructor is for use by concrete measure implementation classes.

SimTK::AbstractMeasure::Implementation::Implementation ( const Implementation &  src)
inlineprotected

Base class copy constructor removes the Subsystem and sets the reference count to zero.

This gets used by the clone() methods in the concrete classes.

virtual SimTK::AbstractMeasure::Implementation::~Implementation ( )
inlineprotectedvirtual

Member Function Documentation

Implementation& SimTK::AbstractMeasure::Implementation::operator= ( const Implementation &  src)
inlineprotected

Base class copy assignment operator removes the Subsystem, and sets the reference count to zero.

This is probably not used.

int SimTK::AbstractMeasure::Implementation::incrRefCount ( ) const
inlineprotected
int SimTK::AbstractMeasure::Implementation::decrRefCount ( ) const
inlineprotected
int SimTK::AbstractMeasure::Implementation::getRefCount ( ) const
inlineprotected
int SimTK::AbstractMeasure::Implementation::getCopyNumber ( ) const
inlineprotected
Implementation* SimTK::AbstractMeasure::Implementation::clone ( ) const
inlineprotected

This is a deep copy of the concrete Implementation object, except the Subsystem will have been removed.

The reference count on the new object will be zero; be sure to increment it if you put it in a handle.

void SimTK::AbstractMeasure::Implementation::realizeModel ( State &  s) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::realizeInstance ( const State &  s) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::realizeTime ( const State &  s) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::realizePosition ( const State &  s) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::realizeVelocity ( const State &  s) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::realizeDynamics ( const State &  s) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::realizeAcceleration ( const State &  s) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::realizeReport ( const State &  s) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::initialize ( State &  s) const
inlineprotected

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 SimTK::AbstractMeasure::Implementation::getNumTimeDerivatives ( ) const
inlineprotected
Stage SimTK::AbstractMeasure::Implementation::getDependsOnStage ( int  derivOrder) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::setSubsystem ( Subsystem &  sub,
MeasureIndex  mx 
)
inlineprotected
bool SimTK::AbstractMeasure::Implementation::isInSubsystem ( ) const
inlineprotected
const Subsystem& SimTK::AbstractMeasure::Implementation::getSubsystem ( ) const
inlineprotected
Subsystem& SimTK::AbstractMeasure::Implementation::updSubsystem ( )
inlineprotected
MeasureIndex SimTK::AbstractMeasure::Implementation::getSubsystemMeasureIndex ( ) const
inlineprotected
SubsystemIndex SimTK::AbstractMeasure::Implementation::getSubsystemIndex ( ) const
inlineprotected
void SimTK::AbstractMeasure::Implementation::invalidateTopologyCache ( ) const
inlineprotected
Stage SimTK::AbstractMeasure::Implementation::getStage ( const State &  s) const
inlineprotected
virtual Implementation* SimTK::AbstractMeasure::Implementation::cloneVirtual ( ) const
protectedpure virtual

Implemented in SimTK::Measure_< T >::Delay::Implementation, SimTK::Measure_< T >::Extreme::Implementation, SimTK::Measure_< T >::Differentiate::Implementation, SimTK::Measure_< T >::Integrate::Implementation, SimTK::Measure_< T >::Scale::Implementation, SimTK::Measure_< T >::Minus::Implementation, SimTK::Measure_< T >::Plus::Implementation, SimTK::Measure_< T >::Sinusoid::Implementation, SimTK::Measure_< T >::Result::Implementation, SimTK::Measure_< T >::Variable::Implementation, SimTK::Measure_< T >::Time::Implementation, and SimTK::Measure_< T >::Constant::Implementation.

virtual void SimTK::AbstractMeasure::Implementation::realizeTopology ( State &  ) const
protectedpure virtual
virtual void SimTK::AbstractMeasure::Implementation::realizeMeasureModelVirtual ( State &  ) const
inlineprotectedvirtual
virtual void SimTK::AbstractMeasure::Implementation::realizeMeasureInstanceVirtual ( const State &  ) const
inlineprotectedvirtual
virtual void SimTK::AbstractMeasure::Implementation::realizeMeasureTimeVirtual ( const State &  ) const
inlineprotectedvirtual
virtual void SimTK::AbstractMeasure::Implementation::realizeMeasurePositionVirtual ( const State &  ) const
inlineprotectedvirtual
virtual void SimTK::AbstractMeasure::Implementation::realizeMeasureVelocityVirtual ( const State &  ) const
inlineprotectedvirtual
virtual void SimTK::AbstractMeasure::Implementation::realizeMeasureDynamicsVirtual ( const State &  ) const
inlineprotectedvirtual
virtual void SimTK::AbstractMeasure::Implementation::realizeMeasureAccelerationVirtual ( const State &  ) const
inlineprotectedvirtual

Reimplemented in SimTK::Measure_< T >::Delay::Implementation, SimTK::Measure_< T >::Extreme::Implementation, SimTK::Measure_< T >::Differentiate::Implementation, and SimTK::Measure_< T >::Integrate::Implementation.

virtual void SimTK::AbstractMeasure::Implementation::realizeMeasureReportVirtual ( const State &  ) const
inlineprotectedvirtual
virtual void SimTK::AbstractMeasure::Implementation::initializeVirtual ( State &  ) const
inlineprotectedvirtual

Reimplemented in SimTK::Measure_< T >::Delay::Implementation, SimTK::Measure_< T >::Extreme::Implementation, SimTK::Measure_< T >::Differentiate::Implementation, and SimTK::Measure_< T >::Integrate::Implementation.

virtual int SimTK::AbstractMeasure::Implementation::getNumTimeDerivativesVirtual ( ) const
inlineprotectedvirtual

Reimplemented in SimTK::Measure_< T >::Delay::Implementation, SimTK::Measure_< T >::Extreme::Implementation, SimTK::Measure_< T >::Differentiate::Implementation, SimTK::Measure_< T >::Integrate::Implementation, SimTK::Measure_< T >::Scale::Implementation, SimTK::Measure_< T >::Minus::Implementation, SimTK::Measure_< T >::Plus::Implementation, SimTK::Measure_< T >::Sinusoid::Implementation, SimTK::Measure_< T >::Result::Implementation, SimTK::Measure_< T >::Variable::Implementation, SimTK::Measure_< T >::Time::Implementation, and SimTK::Measure_< T >::Constant::Implementation.

virtual Stage SimTK::AbstractMeasure::Implementation::getDependsOnStageVirtual ( int  order) const
protectedpure virtual

Implemented in SimTK::Measure_< T >::Delay::Implementation, SimTK::Measure_< T >::Extreme::Implementation, SimTK::Measure_< T >::Differentiate::Implementation, SimTK::Measure_< T >::Integrate::Implementation, SimTK::Measure_< T >::Scale::Implementation, SimTK::Measure_< T >::Minus::Implementation, SimTK::Measure_< T >::Plus::Implementation, SimTK::Measure_< T >::Sinusoid::Implementation, SimTK::Measure_< T >::Result::Implementation, SimTK::Measure_< T >::Variable::Implementation, SimTK::Measure_< T >::Time::Implementation, and SimTK::Measure_< T >::Constant::Implementation.

Friends And Related Function Documentation

friend class AbstractMeasure
friend
friend class Subsystem::Guts
friend
The documentation for this class was generated from the following file: