OpenSim::CoordinateReference Class Reference
Reference value to be achieved for a specified coordinate that will be used via optimization and/or tracking. More...
#include <CoordinateReference.h>
Public Member Functions | |
| virtual | ~CoordinateReference () |
| CoordinateReference () | |
| CoordinateReference (const std::string name, Function &ReferenceFunction) | |
| An implementation of the CoordinateReference. | |
| CoordinateReference & | operator= (const CoordinateReference &aRef) |
| Assign this object to the values of another. | |
| virtual int | getNumRefs () const |
| get the number of referettes (individual signals) in this Reference. | |
| virtual const SimTK::Array_ < std::string > & | getNames () const |
| get the name(s) of the reference or its referettes | |
| virtual void | getValues (const SimTK::State &s, SimTK::Array_< double > &values) const |
| get the value of the Reference as a funcion of the state | |
| virtual void | getWeights (const SimTK::State &s, SimTK::Array_< double > &weights) const |
| get the weighting (importance) of meeting this Reference | |
| virtual double | getValue (const SimTK::State &s) const |
| get the value of the CoordinateReference | |
| virtual double | getSpeedValue (const SimTK::State &s) const |
| get the speed value of the CoordinateReference | |
| virtual double | getAccelerationValue (const SimTK::State &s) const |
| get the speed value of the CoordinateReference | |
| virtual double | getWeight (const SimTK::State &s) const |
| get the weighting (importance) of meeting this CoordinateReference | |
| void | setWeight (double weight) |
| set the weighting (importance) of meeting this CoordinateReference | |
| void | setValueFunction (const OpenSim::Function &function) |
| Set the coordinate value as a function of time. | |
Protected Attributes | |
| PropertyObjPtr< Function > | _coordinateValueFunctionProp |
| Specify the Reference coordinate value as a function of time. | |
| Function *& | _coordinateValueFunction |
| PropertyDbl | _defaultWeightProp |
| Specify the default weight for this coordinate reference. | |
| double & | _defaultWeight |
| SimTK::Array_< std::string > | _names |
Detailed Description
Reference value to be achieved for a specified coordinate that will be used via optimization and/or tracking.
Also contains a weighting that identifies the relative importance of achieving one CoordinateReference relative to others coordinates.
- Version:
- 1.0
Constructor & Destructor Documentation
| virtual OpenSim::CoordinateReference::~CoordinateReference | ( | ) | [inline, virtual] |
| OpenSim::CoordinateReference::CoordinateReference | ( | ) |
| OpenSim::CoordinateReference::CoordinateReference | ( | const std::string | name, | |
| Function & | referenceFunction | |||
| ) |
An implementation of the CoordinateReference.
- Parameters:
-
name of the reference to be found in the model and referenceFunction is its its function returning its value
Member Function Documentation
| double OpenSim::CoordinateReference::getAccelerationValue | ( | const SimTK::State & | s | ) | const [virtual] |
get the speed value of the CoordinateReference
get the acceleration value of the CoordinateReference
| const SimTK::Array_< std::string > & OpenSim::CoordinateReference::getNames | ( | ) | const [virtual] |
get the name(s) of the reference or its referettes
get the names of the referettes
Implements OpenSim::Reference_< double >.
| virtual int OpenSim::CoordinateReference::getNumRefs | ( | ) | const [inline, virtual] |
get the number of referettes (individual signals) in this Reference.
All return arrays are gauranteed to be this length
Implements OpenSim::Reference_< double >.
| double OpenSim::CoordinateReference::getSpeedValue | ( | const SimTK::State & | s | ) | const [virtual] |
get the speed value of the CoordinateReference
| double OpenSim::CoordinateReference::getValue | ( | const SimTK::State & | s | ) | const [virtual] |
get the value of the CoordinateReference
| void OpenSim::CoordinateReference::getValues | ( | const SimTK::State & | s, | |
| SimTK::Array_< double > & | values | |||
| ) | const [virtual] |
get the value of the Reference as a funcion of the state
get the values of the CoordinateReference
Implements OpenSim::Reference_< double >.
| double OpenSim::CoordinateReference::getWeight | ( | const SimTK::State & | s | ) | const [virtual] |
get the weighting (importance) of meeting this CoordinateReference
get the weight of the CoordinateReference
| void OpenSim::CoordinateReference::getWeights | ( | const SimTK::State & | s, | |
| SimTK::Array_< double > & | weights | |||
| ) | const [virtual] |
get the weighting (importance) of meeting this Reference
Implements OpenSim::Reference_< double >.
| CoordinateReference & OpenSim::CoordinateReference::operator= | ( | const CoordinateReference & | aObject | ) |
Assign this object to the values of another.
The XML-associated variable members are not copied-- the XML nodes and/or document must be generated anew for a copied object.
- Returns:
- Reference to this object.
- See also:
- updateXMLNode()
- generateXMLNode()
Reimplemented from OpenSim::Object.
| void OpenSim::CoordinateReference::setValueFunction | ( | const OpenSim::Function & | function | ) | [inline] |
Set the coordinate value as a function of time.
| void OpenSim::CoordinateReference::setWeight | ( | double | weight | ) |
set the weighting (importance) of meeting this CoordinateReference
set the weight of the CoordinateReference
Member Data Documentation
Specify the Reference coordinate value as a function of time.
double& OpenSim::CoordinateReference::_defaultWeight [protected] |
Specify the default weight for this coordinate reference.
SimTK::Array_<std::string> OpenSim::CoordinateReference::_names [protected] |
The documentation for this class was generated from the following files:
- OpenSim/Simulation/CoordinateReference.h
- OpenSim/Simulation/CoordinateReference.cpp
