OpenSim::WeldConstraint Class Reference

A class implementing a Weld Constraint. More...

#include <WeldConstraint.h>

Inheritance diagram for OpenSim::WeldConstraint:

List of all members.

Public Member Functions
	WeldConstraint ()
	Default constructor.
	WeldConstraint (const WeldConstraint &aConstraint)
	Copy constructor.
virtual	~WeldConstraint ()
	Destructor.
virtual Object *	copy () const
	Copy this body and return a pointer to the copy.
WeldConstraint &	operator= (const WeldConstraint &aConstraint)
	Assignment operator.
void	copyData (const WeldConstraint &aConstraint)
	Copy data members from one WeldConstraint to another.
virtual void	setup (Model &aModel)
	Perform some set up functions that happen after the object has been deserialized or copied.
void	createSystem (SimTK::MultibodySystem &system) const
	Create a SimTK::Constraint::Weld which implements this Weld.
void	setBody1ByName (std::string aBodyName)
	Following methods set attributes of the weld constraint.
void	setBody1WeldLocation (SimTK::Vec3 location, SimTK::Vec3 orientation=SimTK::Vec3(0))
void	setBody2ByName (std::string aBodyName)
void	setBody2WeldLocation (SimTK::Vec3 location, SimTK::Vec3 orientation=SimTK::Vec3(0))
Protected Attributes
PropertyStr	_body1NameProp
	Specify first of two bodies welded together by the constraint.
std::string &	_body1Name
PropertyStr	_body2NameProp
	Specify second of two bodies welded by the constraint.
std::string &	_body2Name
PropertyDblVec3	_locationInBody1Prop
	Location of the weld in first body specified in body1 reference frame.
SimTK::Vec3 &	_locationInBody1
PropertyDblVec3	_orientationInBody1Prop
	Orientation of the weld axes on body1 specified in body1's reference frame.
SimTK::Vec3 &	_orientationInBody1
PropertyDblVec3	_locationInBody2Prop
	Location of the weld in second body specified in body2 reference frame.
SimTK::Vec3 &	_locationInBody2
PropertyDblVec3	_orientationInBody2Prop
	Orientation of the weld axes on body2 specified in body2's reference frame.
SimTK::Vec3 &	_orientationInBody2
Body *	_body1
	First body weld constraint joins.
Body *	_body2
	Second body weld constraint joins.
Friends
class	SimbodyEngine

---

Detailed Description

A class implementing a Weld Constraint.

The underlying Constraint in Simbody is a Constraint::Weld

Author:

Ajay Seth

Version:

1.0

---

Constructor & Destructor Documentation

WeldConstraint::WeldConstraint

(

)

Default constructor.

WeldConstraint::WeldConstraint

(

const WeldConstraint &

aConstraint

)

Copy constructor.

Parameters:

aConstraint

WeldConstraint to be copied.

WeldConstraint::~WeldConstraint

(

)

[virtual]

Destructor.

---

Member Function Documentation

Object * WeldConstraint::copy

(

)

const [virtual]

Copy this body and return a pointer to the copy.

The copy constructor for this class is used.

Returns:

Pointer to a copy of this OpenSim::Body.

Reimplemented from OpenSim::Constraint.

void WeldConstraint::copyData

(

const WeldConstraint &

aConstraint

)

Copy data members from one WeldConstraint to another.

Parameters:

aConstraint

WeldConstraint to be copied.

Reimplemented from OpenSim::Constraint.

void WeldConstraint::createSystem

(

SimTK::MultibodySystem &

system

)

const [virtual]

Create a SimTK::Constraint::Weld which implements this Weld.

Reimplemented from OpenSim::ModelComponent.

WeldConstraint & WeldConstraint::operator=

(

const WeldConstraint &

aConstraint

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Constraint.

void WeldConstraint::setBody1ByName

(

std::string

aBodyName

)

Following methods set attributes of the weld constraint.

void OpenSim::WeldConstraint::setBody1WeldLocation	(	SimTK::Vec3	location,
		SimTK::Vec3	orientation = SimTK::Vec3(0)
	)

void WeldConstraint::setBody2ByName

(

std::string

aBodyName

)

void OpenSim::WeldConstraint::setBody2WeldLocation	(	SimTK::Vec3	location,
		SimTK::Vec3	orientation = SimTK::Vec3(0)
	)

void WeldConstraint::setup

(

Model &

aModel

)

[virtual]

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

Parameters:

aModel

OpenSim model containing this WeldConstraint.

Reimplemented from OpenSim::Constraint.

---

Friends And Related Function Documentation

friend class SimbodyEngine [friend]

Reimplemented from OpenSim::Constraint.

---

Member Data Documentation

Body* OpenSim::WeldConstraint::_body1 [protected]

First body weld constraint joins.

std::string& OpenSim::WeldConstraint::_body1Name [protected]

PropertyStr OpenSim::WeldConstraint::_body1NameProp [protected]

Specify first of two bodies welded together by the constraint.

Body* OpenSim::WeldConstraint::_body2 [protected]

Second body weld constraint joins.

std::string& OpenSim::WeldConstraint::_body2Name [protected]

PropertyStr OpenSim::WeldConstraint::_body2NameProp [protected]

Specify second of two bodies welded by the constraint.

SimTK::Vec3& OpenSim::WeldConstraint::_locationInBody1 [protected]

PropertyDblVec3 OpenSim::WeldConstraint::_locationInBody1Prop [protected]

Location of the weld in first body specified in body1 reference frame.

SimTK::Vec3& OpenSim::WeldConstraint::_locationInBody2 [protected]

PropertyDblVec3 OpenSim::WeldConstraint::_locationInBody2Prop [protected]

Location of the weld in second body specified in body2 reference frame.

SimTK::Vec3& OpenSim::WeldConstraint::_orientationInBody1 [protected]

PropertyDblVec3 OpenSim::WeldConstraint::_orientationInBody1Prop [protected]

Orientation of the weld axes on body1 specified in body1's reference frame.

Euler XYZ body-fixed rotation angles are used to express the orientation.

SimTK::Vec3& OpenSim::WeldConstraint::_orientationInBody2 [protected]

PropertyDblVec3 OpenSim::WeldConstraint::_orientationInBody2Prop [protected]

Orientation of the weld axes on body2 specified in body2's reference frame.

Euler XYZ body-fixed rotation angles are used to express the orientation.

---

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

• OpenSim/Simulation/SimbodyEngine/WeldConstraint.h
• OpenSim/Simulation/SimbodyEngine/WeldConstraint.cpp