OpenSim::StateFunction Class Reference
#include <StateFunction.h>
Inheritance diagram for OpenSim::StateFunction:
Public Member Functions | |
| StateFunction () | |
| virtual | ~StateFunction () |
| virtual Object * | copy () const =0 |
| Construct and return a copy of this object. | |
| virtual double | calcValue (const SimTK::State &s) const =0 |
| Calculate the value of this function given the current state of the system. | |
| OPENSIM_DECLARE_DERIVED (StateFunction, Object) | |
Constructor & Destructor Documentation
| OpenSim::StateFunction::StateFunction | ( | ) | [inline] |
| virtual OpenSim::StateFunction::~StateFunction | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual double OpenSim::StateFunction::calcValue | ( | const SimTK::State & | s | ) | const [pure virtual] |
Calculate the value of this function given the current state of the system.
- Parameters:
-
s reference to a SimTK State
Implemented in OpenSim::ForcePerturbationFunction.
| virtual Object* OpenSim::StateFunction::copy | ( | ) | const [pure virtual] |
Construct and return a copy of this object.
The object is allocated using the new operator, so the caller is responsible for deleting the returned object.
- Returns:
- Copy of this object.
Reimplemented from OpenSim::Object.
Implemented in OpenSim::ForcePerturbationFunction.
| OpenSim::StateFunction::OPENSIM_DECLARE_DERIVED | ( | StateFunction | , | |
| Object | ||||
| ) |
The documentation for this class was generated from the following file:
- OpenSim/Common/StateFunction.h
