OpenSim::JointReactionReference Class Reference

#include <JointReactionReference.h>

Inheritance diagram for OpenSim::JointReactionReference:

Public Member Functions
virtual	~JointReactionReference ()
	JointReactionReference ()
	An implementation of the JointReactionReference.
	JointReactionReference (const JointReactionReference &aJointReactionReference)
virtual Object *	copy () const
	Construct and return a copy of this object.
JointReactionReference &	operator= (const JointReactionReference &aRef)
	Assign this object to the values of another.
void	copyData (const JointReactionReference &aRef)
void	setIsOn (bool aBool)
	Set wether the reference is currently on or off.
bool	getIsOn ()
	Get wether the reference is currently on or off.
void	setReceivingBody (std::string aChildOrParent)
	Set the name of the joint to be optimized.
std::string	getReceivingBody () const
void	setReferenceBodyFrame (std::string aChildParentOrGround)
	Chose which bodies reference frame (parent, child, or ground) should be used to express the components of the reference load.
std::string	getReferenceBodyFrame () const
const SimTK::Array_ < std::string > &	getNames () const
	get the names of the joint reaction reference components
void	setNames (SimTK::Array_< std::string > &aNames)
	manually set the names of the joint reaction components
int	getNumRefs () const
	get the number of referettes (individual signals) in this Reference.
virtual void	getValues (const SimTK::State &s, SimTK::Array_< double > &values) const
	get the value of the JointReactionReference three moment components first followed by 3 force components.
virtual void	getWeights (const SimTK::State &s, SimTK::Array_< double > &weights) const
	get the weighting (importance) of meeting this JointReactionReference in the same order as values
virtual void	getWeights (const SimTK::State &s, SimTK::Vec3 &momentWeights, SimTK::Vec3 &forceWeights) const
	get the weighting (importance) of meeting this JointReactionReference in independent vectors for forces and moments.
void	setWeights (SimTK::Array_< double > &weights)
	set the weighting (importance) of meeting this JointReactionReference in the same order as values
void	setWeights (SimTK::Vec3 &momentWeights, SimTK::Vec3 &forceWeights)
	set the 6 weights for the components of the joint load from opensim arrays specifying the moment and force weights independently.
virtual void	updateFromXMLNode ()
	Update this object based on its XML node.
Protected Attributes
PropertyBool	_onProp
	Specify the reference joint reaction values from a file of columns in time.
bool &	_on
PropertyDblVec3	_forceWeightsProp
	Specify the 3 weights dictating the importance of the 3 componenets of the joint force.
SimTK::Vec3 &	_forceWeights
PropertyDblVec3	_momentWeightsProp
	Specify the 3 weights dictating the importance of the 3 componenets of the joint moment.
SimTK::Vec3 &	_momentWeights
PropertyStr	_receivingBodyProp
	A joint is an interface between two bodies, the child and the parent.
std::string &	_receivingBody
PropertyStr	_referenceBodyFrameProp
	The joint load components can be expressed in one of three different reference frames (child, parent, ground) before being multiplied by the weights and added to the cost function.
std::string &	_referenceBodyFrame

Constructor & Destructor Documentation

virtual OpenSim::JointReactionReference::~JointReactionReference ( ) [inline, virtual]

OpenSim::JointReactionReference::JointReactionReference ( )

An implementation of the JointReactionReference.

Parameters:

OpenSim::JointReactionReference::JointReactionReference ( const JointReactionReference & aJointReactionReference )

Member Function Documentation

Object * OpenSim::JointReactionReference::copy ( ) const [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.

void OpenSim::JointReactionReference::copyData ( const JointReactionReference & aRef ) [inline]

bool OpenSim::JointReactionReference::getIsOn ( ) [inline]

Get wether the reference is currently on or off.

const SimTK::Array_< std::string > & OpenSim::JointReactionReference::getNames ( ) const [virtual]

get the names of the joint reaction reference components

Implements OpenSim::Reference_< double >.

int OpenSim::JointReactionReference::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 >.

std::string OpenSim::JointReactionReference::getReceivingBody ( ) const [inline]

std::string OpenSim::JointReactionReference::getReferenceBodyFrame ( ) const [inline]

void OpenSim::JointReactionReference::getValues	(	const SimTK::State &	s,
		SimTK::Array_< double > &	values
	)			const `[virtual]`

get the value of the JointReactionReference three moment components first followed by 3 force components.

get the values of the JointReactionReference

Parameters:

	s,:	SimTK state
	values,:	predefined SimTK::Array where the target values of the reference will be returned.

Implements OpenSim::Reference_< double >.

void OpenSim::JointReactionReference::getWeights	(	const SimTK::State &	s,
		SimTK::Vec3 &	momentWeights,
		SimTK::Vec3 &	forceWeights
	)			const `[virtual]`

get the weighting (importance) of meeting this JointReactionReference in independent vectors for forces and moments.

Parameters:

		s: SimtK state
		momentWeights: predefined SimTK::Vec3 that will be filled with the weights for moment components.
		forceWeihts: predefined SimTK::Vec3 that will be filled with the weights of the force components

void OpenSim::JointReactionReference::getWeights	(	const SimTK::State &	s,
		SimTK::Array_< double > &	weights
	)			const `[virtual]`

get the weighting (importance) of meeting this JointReactionReference in the same order as values

get the 6 weights of the load components

Parameters:

	s,:	SimTK state
	weights,:	predefined SimTK::Array where the target weights of the reference will be returned.

Implements OpenSim::Reference_< double >.

JointReactionReference& OpenSim::JointReactionReference::operator= ( const JointReactionReference & 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.

void OpenSim::JointReactionReference::setIsOn ( bool aBool ) [inline]

Set wether the reference is currently on or off.

void OpenSim::JointReactionReference::setNames ( SimTK::Array_< std::string > & aNames )

manually set the names of the joint reaction components

Parameters:

aNames,:

SimTK::Array_ of six strings to be used as names for the joint load components.

void OpenSim::JointReactionReference::setReceivingBody ( std::string aChildOrParent )

Set the name of the joint to be optimized.

pick which body of the joint pair (parent or child) the reference load should be associated with

Chose which body of the joint pair (parent or child) the reference load should be associated with.

Parameters:

aChildOrParent,:

string that equals "child" or "parent", specifying to report loads occuring on the child or parent body respectively.

void OpenSim::JointReactionReference::setReferenceBodyFrame ( std::string aChildParentOrGround )

Chose which bodies reference frame (parent, child, or ground) should be used to express the components of the reference load.

pick body frame (parent or child or ground) the reference load should be expressed in

Parameters:

aChildParentOrGround,:

string that equals "child", "parent", or "ground", specifying to use loads expressed in the child, parent, or ground body's reference frame respectively.

void OpenSim::JointReactionReference::setWeights	(	SimTK::Vec3 &	momentWeights,
		SimTK::Vec3 &	forceWeights
	)

set the 6 weights for the components of the joint load from opensim arrays specifying the moment and force weights independently.

Parameters:

	momentWeights,:	SimTK::Array of the 3 weights applied to the joint moment components
	forceWeights,:	SimTK::Array of the 3 weights applied to the joint force components

void OpenSim::JointReactionReference::setWeights ( SimTK::Array_< double > & weights )

set the weighting (importance) of meeting this JointReactionReference in the same order as values

set the 6 weights for the components of the joint load from a simtk array of doubles.

Parameters:

weights,:

predifined SimTK::Array that specifies the six weights applied to the joint load terms. First 3 are weights for the moment x, y z components. Last 3 are the weighs for the force x, y , z compoents.

virtual void OpenSim::JointReactionReference::updateFromXMLNode ( ) [inline, virtual]

Update this object based on its XML node.

Added parameter sourceNode to handle external documents For non-inlined objects the root of the childDocument is passed in else NULL.

Reimplemented from OpenSim::Object.

Member Data Documentation

SimTK::Vec3& OpenSim::JointReactionReference::_forceWeights [protected]

PropertyDblVec3 OpenSim::JointReactionReference::_forceWeightsProp [protected]

Specify the 3 weights dictating the importance of the 3 componenets of the joint force.

SimTK::Vec3& OpenSim::JointReactionReference::_momentWeights [protected]

PropertyDblVec3 OpenSim::JointReactionReference::_momentWeightsProp [protected]

Specify the 3 weights dictating the importance of the 3 componenets of the joint moment.

bool& OpenSim::JointReactionReference::_on [protected]

PropertyBool OpenSim::JointReactionReference::_onProp [protected]

Specify the reference joint reaction values from a file of columns in time.

Specify the individual weightings of markers to be matched. Specify the default weight for markers not specified individually. Property to indicate on or off state.

std::string& OpenSim::JointReactionReference::_receivingBody [protected]

PropertyStr OpenSim::JointReactionReference::_receivingBodyProp [protected]

A joint is an interface between two bodies, the child and the parent.

this string determines which load is reported, the load on the child (default) or the load on the parent.

std::string& OpenSim::JointReactionReference::_referenceBodyFrame [protected]

PropertyStr OpenSim::JointReactionReference::_referenceBodyFrameProp [protected]

The joint load components can be expressed in one of three different reference frames (child, parent, ground) before being multiplied by the weights and added to the cost function.

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

OpenSim/Simulation/JointReactionReference.h
OpenSim/Simulation/JointReactionReference.cpp

OpenSim::JointReactionReference Class Reference

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation