OpenSim::InverseDynamicsTool Class Reference

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

#include <InverseDynamicsTool.h>

Inheritance diagram for OpenSim::InverseDynamicsTool:

List of all members.

Public Member Functions
virtual	~InverseDynamicsTool ()
	Destructor.
	InverseDynamicsTool ()
	Default constructor.
	InverseDynamicsTool (const std::string &aFileName, bool aLoadModel=true) SWIG_DECLARE_EXCEPTION
	InverseDynamicsTool (const InverseDynamicsTool &aObject)
	Copy constructor.
virtual OpenSim::Object *	copy () const
	Virtual copy constructor.
virtual void	updateFromXMLNode ()
	Update this object based on its XML node.
InverseDynamicsTool &	operator= (const InverseDynamicsTool &aInverseDynamicsTool)
	Assignment operator.
void	setCoordinateValues (const OpenSim::Storage &aStorage)
bool	hasCoordinateValues ()
std::string	getOutputGenForceFileName ()
const std::string &	getCoordinatesFileName () const
void	setCoordinatesFileName (const std::string &aCoordinateFile)
const double	getLowpassCutoffFrequency () const
void	setLowpassCutoffFrequency (double aFrequency)
virtual bool	run () SWIG_DECLARE_EXCEPTION
	Run the inverse Dynamics tool.
Static Public Member Functions
static void	registerTypes ()
	Register InverseDynamicsTool and any Object types it may employ internally.
Protected Attributes
PropertyStr	_coordinatesFileNameProp
	name of storage file that contains coordinate values for inverse dynamics solving
std::string &	_coordinatesFileName
PropertyDbl	_lowpassCutoffFrequencyProp
	Low-pass cut-off frequency for filtering the coordinates (does not apply to states).
double &	_lowpassCutoffFrequency
PropertyStr	_outputGenForceFileNameProp
std::string &	_outputGenForceFileName

---

Detailed Description

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

Inverse Dynamics is the solution for the generalized-coordinate forces that generate given generalized-coordinate accelerations at a given state. This Tool determines the state from provided coordinate trajectories as functions as that are twice differntiable to estimate velocities and accelerations.

Author:

Ajay Seth

Version:

1.0

---

Constructor & Destructor Documentation

InverseDynamicsTool::~InverseDynamicsTool

(

)

[virtual]

Destructor.

InverseDynamicsTool::InverseDynamicsTool

(

)

Default constructor.

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

InverseDynamicsTool::InverseDynamicsTool

(

const InverseDynamicsTool &

aTool

)

Copy constructor.

Parameters:

aTool

Object to be copied.

---

Member Function Documentation

Object * InverseDynamicsTool::copy

(

)

const [virtual]

Virtual copy constructor.

Implements OpenSim::DynamicsTool.

const std::string& OpenSim::InverseDynamicsTool::getCoordinatesFileName

(

)

const [inline]

const double OpenSim::InverseDynamicsTool::getLowpassCutoffFrequency

(

)

const [inline]

std::string OpenSim::InverseDynamicsTool::getOutputGenForceFileName

(

)

[inline]

bool InverseDynamicsTool::hasCoordinateValues

(

)

InverseDynamicsTool & InverseDynamicsTool::operator=

(

const InverseDynamicsTool &

aTool

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::DynamicsTool.

void InverseDynamicsTool::registerTypes

(

)

[static]

Register InverseDynamicsTool and any Object types it may employ internally.

bool InverseDynamicsTool::run

(

)

[virtual]

Run the inverse Dynamics tool.

Implements OpenSim::DynamicsTool.

void OpenSim::InverseDynamicsTool::setCoordinatesFileName

(

const std::string &

aCoordinateFile

)

[inline]

void InverseDynamicsTool::setCoordinateValues

(

const OpenSim::Storage &

aStorage

)

void OpenSim::InverseDynamicsTool::setLowpassCutoffFrequency

(

double

aFrequency

)

[inline]

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

---

Member Data Documentation

std::string& OpenSim::InverseDynamicsTool::_coordinatesFileName [protected]

PropertyStr OpenSim::InverseDynamicsTool::_coordinatesFileNameProp [protected]

name of storage file that contains coordinate values for inverse dynamics solving

double& OpenSim::InverseDynamicsTool::_lowpassCutoffFrequency [protected]

PropertyDbl OpenSim::InverseDynamicsTool::_lowpassCutoffFrequencyProp [protected]

Low-pass cut-off frequency for filtering the coordinates (does not apply to states).

std::string& OpenSim::InverseDynamicsTool::_outputGenForceFileName [protected]

PropertyStr OpenSim::InverseDynamicsTool::_outputGenForceFileNameProp [protected]

---

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

• OpenSim/Tools/InverseDynamicsTool.h
• OpenSim/Tools/InverseDynamicsTool.cpp