OpenSim::CoordinateCouplerConstraint Class Reference

#include <CoordinateCouplerConstraint.h>

Inheritance diagram for OpenSim::CoordinateCouplerConstraint:

List of all members.

Public Member Functions
	CoordinateCouplerConstraint ()
	CoordinateCouplerConstraint (const CoordinateCouplerConstraint &aConstraint)
virtual	~CoordinateCouplerConstraint ()
virtual Object *	copy () const
	Construct and return a copy of this object.
CoordinateCouplerConstraint &	operator= (const CoordinateCouplerConstraint &aConstraint)
	Assignment operator.
void	copyData (const CoordinateCouplerConstraint &aConstraint)
	Copy data members from one Constraint to another.
void	setIndependentCoordinateNames (const Array< std::string > &aCoordNames)
const Array< std::string > &	getIndependentCoordinateNames () const
void	setDependentCoordinateName (const std::string &aCoordName)
const std::string &	getDependentCoordinateName () const
Function &	getFunction () const
void	setFunction (const Function &aFunction)
void	setFunction (Function *aFunction)
virtual void	scale (const ScaleSet &aScaleSet)
	OPENSIM_DECLARE_DERIVED (CoordinateCouplerConstraint, Constraint)
Protected Member Functions
virtual void	setup (Model &aModel)
	Perform some set up functions that happen after the object has been deserialized or copied.
virtual void	createSystem (SimTK::MultibodySystem &system) const
	Create a SimTK::Constraint::CoordinateCooupler which implements this constraint.
Protected Attributes
PropertyObjPtr< Function >	_functionProp
	Constraint function of generalized coordinates (to be specified) used to evaluate the constraint errors and their derivatives, and must valid to at least 2nd order.
Function *&	_function
PropertyStrArray	_independentCoordNamesProp
	List of names of the independent coordinates (restricted to 1 for now).
Array< std::string > &	_independentCoordNames
PropertyStr	_dependentCoordNameProp
	Name of the dependent coordinate.
std::string &	_dependentCoordName
PropertyDbl	_scaleFactorProp
double &	_scaleFactor
Friends
class	SimbodyEngine

---

Constructor & Destructor Documentation

OpenSim::CoordinateCouplerConstraint::CoordinateCouplerConstraint

(

)

OpenSim::CoordinateCouplerConstraint::CoordinateCouplerConstraint

(

const CoordinateCouplerConstraint &

aConstraint

)

virtual OpenSim::CoordinateCouplerConstraint::~CoordinateCouplerConstraint

(

)

[virtual]

---

Member Function Documentation

virtual Object* OpenSim::CoordinateCouplerConstraint::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.

Implements OpenSim::Constraint.

void OpenSim::CoordinateCouplerConstraint::copyData

(

const CoordinateCouplerConstraint &

aConstraint

)

Copy data members from one Constraint to another.

Parameters:

aConstraint

Constraint to be copied.

Reimplemented from OpenSim::Constraint.

virtual void OpenSim::CoordinateCouplerConstraint::createSystem

(

SimTK::MultibodySystem &

system

)

const [protected, virtual]

Create a SimTK::Constraint::CoordinateCooupler which implements this constraint.

Reimplemented from OpenSim::ModelComponent.

const std::string& OpenSim::CoordinateCouplerConstraint::getDependentCoordinateName

(

)

const [inline]

Function& OpenSim::CoordinateCouplerConstraint::getFunction

(

)

const [inline]

const Array<std::string>& OpenSim::CoordinateCouplerConstraint::getIndependentCoordinateNames

(

)

const [inline]

OpenSim::CoordinateCouplerConstraint::OPENSIM_DECLARE_DERIVED	(	CoordinateCouplerConstraint	,
		Constraint
	)

CoordinateCouplerConstraint& OpenSim::CoordinateCouplerConstraint::operator=

(

const CoordinateCouplerConstraint &

aConstraint

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Constraint.

virtual void OpenSim::CoordinateCouplerConstraint::scale

(

const ScaleSet &

aScaleSet

)

[virtual]

Reimplemented from OpenSim::Constraint.

void OpenSim::CoordinateCouplerConstraint::setDependentCoordinateName

(

const std::string &

aCoordName

)

[inline]

void OpenSim::CoordinateCouplerConstraint::setFunction

(

Function *

aFunction

)

[inline]

void OpenSim::CoordinateCouplerConstraint::setFunction

(

const Function &

aFunction

)

[inline]

void OpenSim::CoordinateCouplerConstraint::setIndependentCoordinateNames

(

const Array< std::string > &

aCoordNames

)

[inline]

virtual void OpenSim::CoordinateCouplerConstraint::setup

(

Model &

aModel

)

[protected, virtual]

Perform some set up functions that happen after the object has been deserialized or copied.

Parameters:

aModel

OpenSim model containing this Constraint.

Reimplemented from OpenSim::Constraint.

---

Friends And Related Function Documentation

friend class SimbodyEngine [friend]

Reimplemented from OpenSim::Constraint.

---

Member Data Documentation

std::string& OpenSim::CoordinateCouplerConstraint::_dependentCoordName [protected]

PropertyStr OpenSim::CoordinateCouplerConstraint::_dependentCoordNameProp [protected]

Name of the dependent coordinate.

Function*& OpenSim::CoordinateCouplerConstraint::_function [protected]

PropertyObjPtr<Function> OpenSim::CoordinateCouplerConstraint::_functionProp [protected]

Constraint function of generalized coordinates (to be specified) used to evaluate the constraint errors and their derivatives, and must valid to at least 2nd order.

Constraint function must evaluate to zero when coordinates satisfy constraint

Array<std::string>& OpenSim::CoordinateCouplerConstraint::_independentCoordNames [protected]

PropertyStrArray OpenSim::CoordinateCouplerConstraint::_independentCoordNamesProp [protected]

List of names of the independent coordinates (restricted to 1 for now).

double& OpenSim::CoordinateCouplerConstraint::_scaleFactor [protected]

PropertyDbl OpenSim::CoordinateCouplerConstraint::_scaleFactorProp [protected]

---

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

• OpenSim/Simulation/SimbodyEngine/CoordinateCouplerConstraint.h