OpenSim::WeldJoint Class Reference

A class implementing an Weld joint. More...

#include <WeldJoint.h>

Inheritance diagram for OpenSim::WeldJoint:
OpenSim::Joint OpenSim::ModelComponent OpenSim::Object

List of all members.

Public Member Functions

 WeldJoint ()
 Weld has no properties.
 WeldJoint (const WeldJoint &aJoint)
 Copy constructor.
 WeldJoint (const std::string &name, OpenSim::Body &parent, SimTK::Vec3 locationInParent, SimTK::Vec3 orientationInParent, OpenSim::Body &body, SimTK::Vec3 locationInBody, SimTK::Vec3 orientationInBody, bool reverse=false)
 Convenience Constructor.
virtual ~WeldJoint ()
 Destructor.
virtual Objectcopy () const
 Copy this body and return a pointer to the copy.
WeldJointoperator= (const WeldJoint &aJoint)
 Assignment operator.
void copyData (const WeldJoint &aJoint)
 Copy data members from one WeldJoint to another.
virtual void setup (Model &aModel)
 Perform some set up functions that happen after the object has been deserialized or copied.
virtual int numCoordinates () const
virtual void scale (const ScaleSet &aScaleSet)
 Scale a joint based on XYZ scale factors for the bodies.
 OPENSIM_DECLARE_DERIVED (WeldJoint, Joint)

Protected Member Functions

void createSystem (SimTK::MultibodySystem &system) const
 This is called when a SimTK System is being created for the Model.

Detailed Description

A class implementing an Weld joint.

The underlying implementation in Simbody is a MobilizedBody::Weld.

Author:
Ajay Seth
Version:
1.0

Constructor & Destructor Documentation

WeldJoint::WeldJoint (  ) 

Weld has no properties.

Default constructor.

WeldJoint::WeldJoint ( const WeldJoint aJoint  ) 

Copy constructor.

Parameters:
aJoint WeldJoint to be copied.
WeldJoint::WeldJoint ( const std::string &  name,
OpenSim::Body parent,
SimTK::Vec3  locationInParent,
SimTK::Vec3  orientationInParent,
OpenSim::Body body,
SimTK::Vec3  locationInBody,
SimTK::Vec3  orientationInBody,
bool  reverse = false 
)

Convenience Constructor.

WeldJoint::~WeldJoint (  )  [virtual]

Destructor.


Member Function Documentation

Object * WeldJoint::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.

Implements OpenSim::Joint.

void WeldJoint::copyData ( const WeldJoint aJoint  ) 

Copy data members from one WeldJoint to another.

Parameters:
aJoint WeldJoint to be copied.

Reimplemented from OpenSim::Joint.

void WeldJoint::createSystem ( SimTK::MultibodySystem &  system  )  const [protected, virtual]

This is called when a SimTK System is being created for the Model.

It must be implemented to add appropriate elements to the System corresponding to this object. Methods for adding modeling options, state variables and their derivatives, discrete variables, as well must be called with createSystem() only.

Parameters:
system the System being created

Reimplemented from OpenSim::Joint.

virtual int OpenSim::WeldJoint::numCoordinates (  )  const [inline, virtual]

Implements OpenSim::Joint.

OpenSim::WeldJoint::OPENSIM_DECLARE_DERIVED ( WeldJoint  ,
Joint   
)
WeldJoint & WeldJoint::operator= ( const WeldJoint aJoint  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::Joint.

void WeldJoint::scale ( const ScaleSet aScaleSet  )  [virtual]

Scale a joint based on XYZ scale factors for the bodies.

Parameters:
aScaleSet Set of XYZ scale factors for the bodies.

Reimplemented from OpenSim::Joint.

void WeldJoint::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 WeldJoint.

Reimplemented from OpenSim::Joint.


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

Generated on Sun Sep 25 00:20:03 2011 for OpenSim by  doxygen 1.6.1