OpenSim  OpenSim 3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::DynamicsTool Class Reference

An abstract Tool for defining tools for perfroming a dynamics analysis with a given model. More...

#include <DynamicsTool.h>

Inheritance diagram for OpenSim::DynamicsTool:
OpenSim::Tool OpenSim::Object OpenSim::InverseDynamicsTool

Public Member Functions

virtual ~DynamicsTool ()
 DynamicsTool ()
 DynamicsTool (const std::string &aFileName, bool aLoadModel=true) SWIG_DECLARE_EXCEPTION
 DynamicsTool (const DynamicsTool &aTool)
void disableModelForces (Model &model, SimTK::State &s, const Array< std::string > &forcesByNameOrGroup)
 Modify model to exclude specified forces by disabling those identified by name or group.
const ExternalLoadsgetExternalLoads () const
ExternalLoadsupdExternalLoads ()
const std::string & getExternalLoadsFileName () const
void setExternalLoadsFileName (const std::string &aFileName)
DynamicsTooloperator= (const DynamicsTool &aDynamicsTool)
void setStartTime (double d)
double getStartTime () const
void setEndTime (double d)
double getEndTime () const
void setModel (Model &aModel)
void setExcludedForces (const Array< std::string > &aExcluded)
bool createExternalLoads (const std::string &aExternalLoadsFileName, Model &aModel, const Storage *loadKinematics=NULL)
virtual bool run () SWIG_DECLARE_EXCEPTION=0
 The run() method of a Tool embodies what would be the main() routine for a standalone program.
- Public Member Functions inherited from OpenSim::Tool
virtual ~Tool ()
 Destructor.
 Tool ()
 Default constructor.
 Tool (const std::string &aFileName, bool aUpdateFromXMLNode=true)
 Construct from file.
 Tool (const Tool &aTool)
 Copy constructor.
Tooloperator= (const Tool &source)
 Assignment operator.
const std::string & getInputsDir () const
 Get/set Inputs Directory.
void setInputsDir (const std::string &aString)
const std::string & getResultsDir () const
 Get/set Results Directory.
void setResultsDir (const std::string &aString)
const VerboseLevel getVerboseLevel () const
 Get/Set verbose level.
void setVerboseLevel (const VerboseLevel aVerboseLevel)
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup.
virtual Objectclone () const =0
 
Create a new heap-allocated copy of the concrete object to which this 

Object refers.

virtual const std::string & getConcreteClassName () const =0
 
Returns the class name of the concrete %Object-derived class of the

actual object referenced by this Object, as a string.

virtual const VisibleObjectgetDisplayer () const
 Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
virtual VisibleObjectupdDisplayer ()
 get Non const pointer to VisibleObject
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading.
Objectoperator= (const Object &aObject)
 
Copy assignment copies he base class fields, including the 

properties.

virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal.
virtual bool operator< (const Object &aObject) const
 
Provide an ordering for objects so they can be put in sorted

containers.

void setName (const std::string &name)
 Set the name of the Object.
const std::string & getName () const
 Get the name of this Object.
void setDescription (const std::string &description)
 Set description, a one-liner summary.
const std::string & getDescription () const
 Get description, a one-liner summary.
const std::string & getAuthors () const
 Get Authors of this Object.
void setAuthors (const std::string &authors)
 Set Authors of this object, call this method in your constructor if needed.
const std::string & getReferences () const
 Get references or publications to cite if using this object.
void setReferences (const std::string &references)
 Set references or publications to cite if using this object.
int getNumProperties () const
 Determine how many properties are stored with this Object.
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 
Get a const reference to a property by its index number, returned as

an AbstractProperty.

AbstractPropertyupdPropertyByIndex (int propertyIndex)
 
Get a writable reference to a property by its index number, returned as

an AbstractProperty.

bool hasProperty (const std::string &name) const
 
Return true if this %Object has a property of any type with the 

given name, which must not be empty.

const AbstractPropertygetPropertyByName (const std::string &name) const
 
Get a const reference to a property by its name, returned as

an AbstractProperty.

AbstractPropertyupdPropertyByName (const std::string &name)
 
Get a writable reference to a property by its name, returned as

an AbstractProperty.

template<class T >
bool hasProperty () const
 
Return true if this %Object contains an unnamed, one-object property

that contains objects of the given template type T.

template<class T >
const Property< T > & getProperty (const PropertyIndex &index) const
 
Get property of known type Property\<T> as a const reference; 

the property must be present and have the right type.

template<class T >
Property< T > & updProperty (const PropertyIndex &index)
 
Get property of known type Property\<T> as a writable reference;

the property must be present and have the right type.

void setObjectIsUpToDateWithProperties ()
 
When an object is initialized using the current values of its 

properties, it can set a flag indicating that it is up to date.

bool isObjectUpToDateWithProperties () const
 
Returns \c true if any property's value has changed since the last time

setObjectIsUpToDateWithProperties() was called.

void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object.
virtual void updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
 Use this method to deserialize an object from a SimTK::Xml::Element.
virtual void updateXMLNode (SimTK::Xml::Element &parent)
 Serialize this object into the XML node that represents it.
bool getInlined () const
 
Inlined means an in-memory Object that is not associated with

an XMLDocument.

void setInlined (bool aInlined, const std::string &aFileName="")
 
Mark this as inlined or not and optionally provide a file name

to associate with the new XMLDocument for the non-inline case.

std::string getDocumentFileName () const
 
If there is a document associated with this object then return the

file name maintained by the document.

void setAllPropertiesUseDefault (bool aUseDefault)
bool print (const std::string &fileName)
 
Write this %Object into an XML file of the given name; conventionally

the suffix to use is ".osim".

std::string dump (bool dumpName=false)
 dump the XML representation of this Object into an std::string and return it.
void clearObjectIsUpToDateWithProperties ()
 
For testing or debugging purposes, manually clear the "object is up to 

date with respect to properties" flag.

virtual bool isA (const char *type) const
 
The default implementation returns true only if the supplied string

is "Object"; each Object-derived class overrides this to match its own class name.

const std::string & toString () const
 
Wrapper to be used on Java side to display objects in tree; this returns

just the object's name.

PropertySetgetPropertySet ()
 
OBSOLETE: Get a reference to the PropertySet maintained by the 

Object.

const PropertySetgetPropertySet () const

Protected Attributes

Model_model
 Pointer to the model being investigated.
PropertyStr _modelFileNameProp
 Name of the xml file used to deserialize or construct a model.
std::string & _modelFileName
PropertyDblVec2 _timeRangeProp
 The range of time over which to perform the dynamics analysis.
SimTK::Vec2 & _timeRange
PropertyStrArray _excludedForcesProp
 Idenitify the list of forces to be ignored for computing dynamics.
Array< std::string > & _excludedForces
OpenSim::PropertyStr _externalLoadsFileNameProp
 Name of the file containing the external loads applied to the model.
std::string & _externalLoadsFileName
ExternalLoads _externalLoads
 External loads object that manages loading and applying external forces to the model, including transformations required by the Tool.
- Protected Attributes inherited from OpenSim::Tool
PropertyStr _inputsDirProp
 Directory for reading inputs (model, settings, etc...) from.
std::string & _inputsDir
PropertyStr _resultsDirProp
 Directory for writing results (new model, states, etc...) to.
std::string & _resultsDir
VerboseLevel _verboseLevel
 How much details to put out while running.
- Protected Attributes inherited from OpenSim::Object
PropertySet _propertySet
 
OBSOLETE: Property_Deprecated set for serializable member variables of 

this and derived classes.

Additional Inherited Members

- Public Types inherited from OpenSim::Tool
enum  VerboseLevel { Quiet = 0, Progress = 1, DetailedProgress = 2, Debug = 3 }
 Perturbation types. More...
- Static Public Member Functions inherited from OpenSim::Object
static void registerType (const Object &defaultObject)
 
Register an instance of a class; if the class is already registered it

will be replaced.

static void renameType (const std::string &oldTypeName, const std::string &newTypeName)
 
Support versioning by associating the current %Object type with an 

old name.

static const ObjectgetDefaultInstanceOfType (const std::string &concreteClassName)
 
Return a pointer to the default instance of the registered (concrete)

Object whose class name is given, or NULL if the type is not registered.

template<class T >
static bool isObjectTypeDerivedFrom (const std::string &concreteClassName)
 
Return true if the given concrete object type represents a subclass of 

the template object type T, and thus could be referenced with a T*.

static ObjectnewInstanceOfType (const std::string &concreteClassName)
 
Create a new instance of the concrete %Object type whose class name is 

given as concreteClassName.

static void getRegisteredTypenames (Array< std::string > &typeNames)
 Retrieve all the typenames registered so far.
template<class T >
static void getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
 
Return an array of pointers to the default instances of all registered

(concrete) Object types that derive from a given Object-derived type that does not have to be concrete.

static void PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName)
 
Dump formatted property information to a given output stream, useful

for creating a "help" facility for registered objects.

static void PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName)
 
Same as the other signature but the class name and property name are

provided as two separate strings.

static ObjectmakeObjectFromFile (const std::string &fileName)
 
Create an %OpenSim object whose type is based on the tag at the root 

node of the XML file passed in.

static const std::string & getClassName ()
 Return the name of this class as a string; i.e., "Object".
static void setSerializeAllDefaults (bool shouldSerializeDefaults)
 
Static function to control whether all registered objects and

their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically.

static bool getSerializeAllDefaults ()
 Report the value of the "serialize all defaults" flag.
static bool isKindOf (const char *type)
 
Returns true if the passed-in string is "Object"; each %Object-derived

class defines a method of this name for its own class name.

static void setDebugLevel (int newLevel)
 Set the debug level to get verbose output.
static int getDebugLevel ()
 Get current setting of debug level.
static ObjectSafeCopy (const Object *aObject)
 
Use the clone() method to duplicate the given object unless the pointer

is null in which case null is returned.

static void RegisterType (const Object &defaultObject)
 OBSOLETE alternate name for registerType().
static void RenameType (const std::string &oldName, const std::string &newName)
 OBSOLETE alternate name for renameType().
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized.
- Protected Member Functions inherited from OpenSim::Object
 Object ()
 
 The default constructor is only for use by constructors of 

derived types.

 Object (const std::string &fileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
 
Constructor from a file, to be called from other constructors that 

take a file as input.

 Object (const Object &source)
 
Copy constructor is invoked automatically by derived classes with

default copy constructors; otherwise it must be invoked explicitly.

 Object (SimTK::Xml::Element &aElement)
 
Construct the base class portion of an %Object from a given Xml 

element that describes this Object.

template<class T >
PropertyIndex addProperty (const std::string &name, const std::string &comment, const T &value)
 
Define a new single-value property of known type T, with the given 

name, associated comment, and initial value.

template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment)
 
Add an optional property, meaning it can contain either no value or

a single value.

template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment, const T &value)
 
Add an optional property, meaning it can contain either no value or

a single value.

template<class T >
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize)
 
Define a new list-valued property of known type T, with the given 

name, associated comment, minimum (==0) and maximum (>0) allowable list lengths, and a zero-length initial value.

template<class T , template< class > class Container>
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize, const Container< T > &valueList)
 
Define a new list-valued property as above, but assigning an initial

value via some templatized container class that supports size() and indexing.

PropertyIndex getPropertyIndex (const std::string &name) const
 
Look up a property by name and return its PropertyIndex if it is

found.

template<class T >
PropertyIndex getPropertyIndex () const
 
Look up an unnamed property by the type of object it contains,

and return its PropertyIndex if it is found.

void updateFromXMLDocument ()
 
Use this method only if you're deserializing from a file and the object

is at the top level; that is, primarily in constructors that take a file name as input.

void setDocument (XMLDocument *doc)
 Unconditionally set the XMLDocument associated with this object.
const XMLDocumentgetDocument () const
 
Get a const pointer to the document (if any) associated with this

object.

XMLDocumentupdDocument ()
 
Get a writable pointer to the document (if any) associated with this

object.

Detailed Description

An abstract Tool for defining tools for perfroming a dynamics analysis with a given model.

For example, InverseDynamics and ForwardDynamics Tools derive from DynamicsTool, which provides convenient method for performing and dynamics analysis over or to produce a trajectory in time.

Author
Ajay Seth
Version
1.0

Constructor & Destructor Documentation

virtual OpenSim::DynamicsTool::~DynamicsTool ( )
virtual
OpenSim::DynamicsTool::DynamicsTool ( )
OpenSim::DynamicsTool::DynamicsTool ( const std::string &  aFileName,
bool  aLoadModel = true 
)
OpenSim::DynamicsTool::DynamicsTool ( const DynamicsTool aTool)

Member Function Documentation

bool OpenSim::DynamicsTool::createExternalLoads ( const std::string &  aExternalLoadsFileName,
Model aModel,
const Storage loadKinematics = NULL 
)
void OpenSim::DynamicsTool::disableModelForces ( Model model,
SimTK::State &  s,
const Array< std::string > &  forcesByNameOrGroup 
)

Modify model to exclude specified forces by disabling those identified by name or group.

double OpenSim::DynamicsTool::getEndTime ( ) const
inline
const ExternalLoads& OpenSim::DynamicsTool::getExternalLoads ( ) const
inline
const std::string& OpenSim::DynamicsTool::getExternalLoadsFileName ( ) const
inline
double OpenSim::DynamicsTool::getStartTime ( ) const
inline
DynamicsTool& OpenSim::DynamicsTool::operator= ( const DynamicsTool aDynamicsTool)
virtual bool OpenSim::DynamicsTool::run ( )
pure virtual

The run() method of a Tool embodies what would be the main() routine for a standalone program.

Therefore, any OpenSim main program can become a Tool executable from the GUI by making it a run() method for a new Tool.

It is expected that the run() method be composed of a sequence of calls to underlying computational and reporting objects and should

Implements OpenSim::Tool.

Implemented in OpenSim::InverseDynamicsTool.

void OpenSim::DynamicsTool::setEndTime ( double  d)
inline
void OpenSim::DynamicsTool::setExcludedForces ( const Array< std::string > &  aExcluded)
inline
void OpenSim::DynamicsTool::setExternalLoadsFileName ( const std::string &  aFileName)
inline
void OpenSim::DynamicsTool::setModel ( Model aModel)
inline
void OpenSim::DynamicsTool::setStartTime ( double  d)
inline
ExternalLoads& OpenSim::DynamicsTool::updExternalLoads ( )
inline

Member Data Documentation

Array<std::string>& OpenSim::DynamicsTool::_excludedForces
protected
PropertyStrArray OpenSim::DynamicsTool::_excludedForcesProp
protected

Idenitify the list of forces to be ignored for computing dynamics.

ExternalLoads OpenSim::DynamicsTool::_externalLoads
protected

External loads object that manages loading and applying external forces to the model, including transformations required by the Tool.

std::string& OpenSim::DynamicsTool::_externalLoadsFileName
protected
OpenSim::PropertyStr OpenSim::DynamicsTool::_externalLoadsFileNameProp
protected

Name of the file containing the external loads applied to the model.

Model* OpenSim::DynamicsTool::_model
protected

Pointer to the model being investigated.

std::string& OpenSim::DynamicsTool::_modelFileName
protected
PropertyStr OpenSim::DynamicsTool::_modelFileNameProp
protected

Name of the xml file used to deserialize or construct a model.

SimTK::Vec2& OpenSim::DynamicsTool::_timeRange
protected
PropertyDblVec2 OpenSim::DynamicsTool::_timeRangeProp
protected

The range of time over which to perform the dynamics analysis.


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