OpenSim::Reference_< T > Class Template Reference
This base (abstract) class defines the interface for objects repsonsible in identifying a model output and its Reference value to be achieved via optimization and/or tracking. More...
#include <Reference.h>
Public Member Functions | |
| virtual | ~Reference_ () |
| Reference_ () | |
| Reference_ (std::string name) | |
| Reference_ & | operator= (const Reference_ &aRef) |
| Assign this object to the values of another. | |
| virtual int | getNumRefs () const =0 |
| get the number of referettes (individual signals) in this Reference. | |
| virtual SimTK::Vec2 | getValidTimeRange () const |
| get the time range for which the Reference is valid, which can and will be finite if reference encapsulates experimental data. | |
| virtual const SimTK::Array_ < std::string > & | getNames () const =0 |
| get the name(s) of the reference or its referettes | |
| virtual void | getValues (const SimTK::State &s, SimTK::Array_< T > &values) const =0 |
| get the value of the Reference as a funcion of the state | |
| virtual void | getWeights (const SimTK::State &s, SimTK::Array_< double > &weights) const =0 |
| get the weighting (importance) of meeting this Reference | |
| virtual SimTK::Array_< T > | getValues (const SimTK::State &s) const |
| virtual SimTK::Array_< double > | getWeights (const SimTK::State &s) const |
Detailed Description
template<class T>
class OpenSim::Reference_< T >
This base (abstract) class defines the interface for objects repsonsible in identifying a model output and its Reference value to be achieved via optimization and/or tracking.
Also contains a weighting that identifies the relative importance of achieving one Reference relative to others. The specific value type to be defined by the concrete References.
- Version:
- 1.0
Constructor & Destructor Documentation
| virtual OpenSim::Reference_< T >::~Reference_ | ( | ) | [inline, virtual] |
| OpenSim::Reference_< T >::Reference_ | ( | ) | [inline] |
| OpenSim::Reference_< T >::Reference_ | ( | std::string | name | ) | [inline] |
Member Function Documentation
| virtual const SimTK::Array_<std::string>& OpenSim::Reference_< T >::getNames | ( | ) | const [pure virtual] |
get the name(s) of the reference or its referettes
Implemented in OpenSim::CoordinateReference, OpenSim::JointReactionReference, and OpenSim::MarkersReference.
| virtual int OpenSim::Reference_< T >::getNumRefs | ( | ) | const [pure virtual] |
get the number of referettes (individual signals) in this Reference.
All return arrays are gauranteed to be this length
Implemented in OpenSim::CoordinateReference, OpenSim::JointReactionReference, and OpenSim::MarkersReference.
| virtual SimTK::Vec2 OpenSim::Reference_< T >::getValidTimeRange | ( | ) | const [inline, virtual] |
get the time range for which the Reference is valid, which can and will be finite if reference encapsulates experimental data.
By defualt they are infinite
Reimplemented in OpenSim::MarkersReference.
| virtual SimTK::Array_<T> OpenSim::Reference_< T >::getValues | ( | const SimTK::State & | s | ) | const [inline, virtual] |
| virtual void OpenSim::Reference_< T >::getValues | ( | const SimTK::State & | s, | |
| SimTK::Array_< T > & | values | |||
| ) | const [pure virtual] |
get the value of the Reference as a funcion of the state
Implemented in OpenSim::CoordinateReference, OpenSim::JointReactionReference, and OpenSim::MarkersReference.
| virtual SimTK::Array_<double> OpenSim::Reference_< T >::getWeights | ( | const SimTK::State & | s | ) | const [inline, virtual] |
| virtual void OpenSim::Reference_< T >::getWeights | ( | const SimTK::State & | s, | |
| SimTK::Array_< double > & | weights | |||
| ) | const [pure virtual] |
get the weighting (importance) of meeting this Reference
Implemented in OpenSim::CoordinateReference, OpenSim::JointReactionReference, and OpenSim::MarkersReference.
| Reference_& OpenSim::Reference_< T >::operator= | ( | const Reference_< T > & | aObject | ) | [inline] |
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.
The documentation for this class was generated from the following file:
- OpenSim/Simulation/Reference.h
