OpenSim::InverseKinematicsTool Class Reference

A Tool that performs an Inverse Kinematics analysis with a given model. More...

#include <InverseKinematicsTool.h>

Inheritance diagram for OpenSim::InverseKinematicsTool:
OpenSim::Tool OpenSim::Object

List of all members.

Public Member Functions

virtual ~InverseKinematicsTool ()
 Destructor.
 InverseKinematicsTool ()
 Default constructor.
 InverseKinematicsTool (const std::string &aFileName, bool aLoadModel=true) SWIG_DECLARE_EXCEPTION
 InverseKinematicsTool (const InverseKinematicsTool &aObject)
 Copy constructor.
virtual OpenSim::Objectcopy () const
 Virtual copy constructor.
virtual void updateFromXMLNode ()
 Update this object based on its XML node.
void setModel (Model &aModel)
void setStartTime (double d)
double getStartTime () const
void setEndTime (double d)
double getEndTime () const
void setMarkerDataFileName (const std::string &markerDataFileName)
const std::string & getMarkerDataFileName () const
void setCoordinateFileName (const std::string &coordDataFileName)
const std::string & getCoordinateFileName () const
InverseKinematicsTooloperator= (const InverseKinematicsTool &aInverseKinematicsTool)
 Assignment operator.
std::string getOutputMotionFileName ()
IKTaskSetgetIKTaskSet ()
virtual bool run () SWIG_DECLARE_EXCEPTION
 Run the inverse kinematics tool.

Static Public Member Functions

static void registerTypes ()
 Register InverseKinematicsTool and any Object types it may employ internally.

Detailed Description

A Tool that performs an Inverse Kinematics analysis with a given model.

Inverse kinematics is the solution of internal coordinates that poses the model such that the landmark locations (markers), affixed to the model, minimize the weighted least-squares error with observations of markers in spatial coordinates. Observations of coordinates can also be included.

Author:
Ajay Seth
Version:
1.0

Constructor & Destructor Documentation

InverseKinematicsTool::~InverseKinematicsTool (  )  [virtual]

Destructor.

InverseKinematicsTool::InverseKinematicsTool (  ) 

Default constructor.

OpenSim::InverseKinematicsTool::InverseKinematicsTool ( const std::string &  aFileName,
bool  aLoadModel = true 
)
InverseKinematicsTool::InverseKinematicsTool ( const InverseKinematicsTool aTool  ) 

Copy constructor.

Parameters:
aTool Object to be copied.

Member Function Documentation

Object * InverseKinematicsTool::copy (  )  const [virtual]

Virtual copy constructor.

Reimplemented from OpenSim::Object.

const std::string& OpenSim::InverseKinematicsTool::getCoordinateFileName (  )  const [inline]
double OpenSim::InverseKinematicsTool::getEndTime (  )  const [inline]
IKTaskSet& OpenSim::InverseKinematicsTool::getIKTaskSet (  )  [inline]
const std::string& OpenSim::InverseKinematicsTool::getMarkerDataFileName (  )  const [inline]
std::string OpenSim::InverseKinematicsTool::getOutputMotionFileName (  )  [inline]
double OpenSim::InverseKinematicsTool::getStartTime (  )  const [inline]
InverseKinematicsTool & InverseKinematicsTool::operator= ( const InverseKinematicsTool aTool  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::Tool.

void InverseKinematicsTool::registerTypes (  )  [static]

Register InverseKinematicsTool and any Object types it may employ internally.

bool InverseKinematicsTool::run (  )  [virtual]

Run the inverse kinematics tool.

Implements OpenSim::Tool.

void OpenSim::InverseKinematicsTool::setCoordinateFileName ( const std::string &  coordDataFileName  )  [inline]
void OpenSim::InverseKinematicsTool::setEndTime ( double  d  )  [inline]
void OpenSim::InverseKinematicsTool::setMarkerDataFileName ( const std::string &  markerDataFileName  )  [inline]
void OpenSim::InverseKinematicsTool::setModel ( Model aModel  )  [inline]
void OpenSim::InverseKinematicsTool::setStartTime ( double  d  )  [inline]
void InverseKinematicsTool::updateFromXMLNode (  )  [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.


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

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