API  4.2
For C++ developers
OpenSim::RRATool Class Reference

An abstract class for specifying the interface for an investigation. More...

+ Inheritance diagram for OpenSim::RRATool:

Public Member Functions

virtual ~RRATool ()
 
 RRATool ()
 
 RRATool (const std::string &aFileName, bool aLoadModel=true)
 
 RRATool (const RRATool &aObject)
 
RRATooloperator= (const RRATool &aRRATool)
 
const std::string & getDesiredPointsFileName ()
 
void setDesiredPointsFileName (const std::string &aFileName)
 
const std::string & getDesiredKinematicsFileName ()
 
void setDesiredKinematicsFileName (const std::string &aFileName)
 
const std::string & getConstraintsFileName ()
 
void setConstraintsFileName (const std::string &aFileName)
 
const std::string & getTaskSetFileName ()
 
void setTaskSetFileName (const std::string &aFileName)
 
const std::string & getOutputModelFileName ()
 
void setOutputModelFileName (const std::string &aFileName)
 
bool getAdjustCOMToReduceResiduals ()
 
void setAdjustCOMToReduceResiduals (bool aAdjust)
 
const std::string & getAdjustedCOMBody ()
 
void setAdjustedCOMBody (const std::string &aBody)
 
double getLowpassCutoffFrequency () const
 
void setLowpassCutoffFrequency (double aLowpassCutoffFrequency)
 
const std::string & getExternalLoadsFileName () const
 
void setExternalLoadsFileName (const std::string &aFileName)
 
bool run () override
 
StoragegetForceStorage ()
 
void setOriginalForceSet (const ForceSet &aForceSet)
 
void updateFromXMLNode (SimTK::Xml::Element &aNode, int versionNumber=-1) override
 Use this method to deserialize an object from a SimTK::Xml::Element. More...
 
void initializeControlSetUsingConstraints (const ControlSet *aRRAControlSet, const ControlSet *aControlConstraints, ControlSet &rControlSet)
 
std::string adjustCOMToReduceResiduals (SimTK::State &s, const Storage &qStore, const Storage &uStore)
 
std::string adjustCOMToReduceResiduals (const OpenSim::Array< double > &aFAve, const OpenSim::Array< double > &aMAve)
 
void addNecessaryAnalyses ()
 
void writeAdjustedModel ()
 
- Public Member Functions inherited from OpenSim::AbstractTool
virtual ~AbstractTool ()
 Destructor. More...
 
 AbstractTool ()
 Default constructor. More...
 
 AbstractTool (const std::string &aFileName, bool aUpdateFromXMLNode=true)
 Construct from file, and an optional GuiModel. More...
 
 AbstractTool (const AbstractTool &aObject)
 Copy constructor. More...
 
AbstractTooloperator= (const AbstractTool &aTool)
 Assignment operator. More...
 
virtual void setModel (Model &aModel)
 Set the model to be investigated. More...
 
virtual ModelgetModel () const
 Get the model to be investigated. More...
 
bool getReplaceForceSet () const
 
void setReplaceForceSet (bool aReplace)
 
std::string getNextAvailableForceName (const std::string prefix="Force") const
 
const ExternalLoadsgetExternalLoads () const
 
ExternalLoadsupdExternalLoads ()
 
void setExternalLoads (ExternalLoads &el)
 
bool modelHasExternalLoads ()
 
const std::string & getExternalLoadsFileName () const
 
void setExternalLoadsFileName (const std::string &aFileName)
 
Array< std::string > & getForceSetFiles ()
 
void setForceSetFiles (const Array< std::string > &aForceSetFiles)
 
int getOutputPrecision () const
 
void setOutputPrecision (int aPrecision)
 
const AnalysisSetgetAnalysisSet () const
 
AnalysisSetupdAnalysisSet () const
 
const ControllerSetgetControllerSet () const
 
ControllerSetupdControllerSet () const
 
const std::string & getResultsDir () const
 Get Results Directory. More...
 
void setResultsDir (const std::string &aString)
 
double getInitialTime () const
 
double getFinalTime () const
 
void setInitialTime (const double aInitialTime)
 
void setFinalTime (const double aFinalTime)
 
double getStartTime () const
 
void setStartTime (const double aStartTime)
 
int getMaximumNumberOfSteps () const
 
void setMaximumNumberOfSteps (int aMaxSteps)
 
double getMaxDT () const
 
void setMaxDT (double aMaxDT)
 
double getMinDT () const
 
void setMinDT (double aMinDT)
 
double getErrorTolerance () const
 
void setErrorTolerance (double aErrorTolerance)
 
const std::string & getModelFilename () const
 
void setModelFilename (const std::string &aModelFile)
 
bool getSolveForEquilibrium () const
 
void setSolveForEquilibrium (bool aSolve)
 
void loadModel (const std::string &aToolSetupFileName, ForceSet *rOriginalForceSet=0)
 Load and construct a model based on the property settings of this investigation. More...
 
void updateModelForces (Model &model, const std::string &aToolSetupFileName, ForceSet *rOriginalForceSet=0)
 Update the forces applied to a model. More...
 
void addAnalysisSetToModel ()
 Adds Analysis objects from analysis set to model. More...
 
void addControllerSetToModel ()
 
void removeControllerSetFromModel ()
 Remove Analysis objects that were added earlier from analysis set to model. More...
 
void removeAnalysisSetFromModel ()
 
void setToolOwnsModel (const bool trueFalse)
 
bool getToolOwnsModel () const
 
std::string getControlsFileName () const
 
void setControlsFileName (const std::string &controlsFilename)
 
void printResults (const std::string &aBaseName, const std::string &aDir="", double aDT=-1.0, const std::string &aExtension=".sto")
 Print the results of the analysis. More...
 
bool createExternalLoads (const std::string &externalLoadsFileName, Model &model)
 
void removeExternalLoadsFromModel ()
 
virtual void loadQStorage (const std::string &statesFileName, Storage &rQStore) const
 
void assign (Object &aObject) override
 This allows copy assignment in the Java GUI. More...
 
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup. More...
 
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading. More...
 
Objectoperator= (const Object &aObject)
 Copy assignment copies he base class fields, including the properties. More...
 
virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal. More...
 
virtual bool operator< (const Object &aObject) const
 Provide an ordering for objects so they can be put in sorted containers. More...
 
void setName (const std::string &name)
 Set the name of the Object. More...
 
const std::string & getName () const
 Get the name of this Object. More...
 
void setDescription (const std::string &description)
 Set description, a one-liner summary. More...
 
const std::string & getDescription () const
 Get description, a one-liner summary. More...
 
const std::string & getAuthors () const
 Get Authors of this Object. More...
 
void setAuthors (const std::string &authors)
 Set Authors of this object. More...
 
const std::string & getReferences () const
 Get references or publications to cite if using this object. More...
 
void setReferences (const std::string &references)
 Set references or publications to cite if using this object. More...
 
int getNumProperties () const
 Determine how many properties are stored with this Object. More...
 
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByIndex (int propertyIndex)
 Get a writable reference to a property by its index number, returned as an AbstractProperty. More...
 
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. More...
 
const AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByName (const std::string &name)
 Get a writable reference to a property by its name, returned as an AbstractProperty. More...
 
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. More...
 
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. More...
 
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. More...
 
bool isObjectUpToDateWithProperties () const
 Returns true if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...
 
void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object. More...
 
void updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const
 Serialize this object into the XML node that represents it. More...
 
bool getInlined () const
 Inlined means an in-memory Object that is not associated with an XMLDocument. More...
 
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. More...
 
std::string getDocumentFileName () const
 If there is a document associated with this object then return the file name maintained by the document. More...
 
int getDocumentFileVersion () const
 If there is a document associated with this object then return its version number. More...
 
void setAllPropertiesUseDefault (bool aUseDefault)
 
bool print (const std::string &fileName) const
 Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...
 
std::string dump () const
 dump the XML representation of this Object into an std::string and return it. More...
 
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. More...
 
const std::string & toString () const
 Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...
 
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
 
const PropertySetgetPropertySet () const
 

Public Types

typedef RRATool Self
 This typedef might be useful within the member functions of this class. More...
 
typedef AbstractTool Super
 Use this typedef to refer to the superclass of this class. More...
 
- Public Types inherited from OpenSim::AbstractTool
typedef AbstractTool Self
 This typedef might be useful within the member functions of this class. More...
 
typedef Object Super
 Use this typedef to refer to the superclass of this class. More...
 

Static Public Member Functions

static void computeAverageResiduals (const Storage &aForceStore, OpenSim::Array< double > &rFAve, OpenSim::Array< double > &rMAve)
 
static void computeAverageResiduals (SimTK::State &s, Model &aModel, double aTi, double aTf, const Storage &aStatesStore, OpenSim::Array< double > &rFAve, OpenSim::Array< double > &rMAve)
 
- Static Public Member Functions inherited from OpenSim::AbstractTool
static AbstractToolsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "AbstractTool". 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. More...
 
static void renameType (const std::string &oldTypeName, const std::string &newTypeName)
 Support versioning by associating the current Object type with an old name. More...
 
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. More...
 
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*. More...
 
static ObjectnewInstanceOfType (const std::string &concreteClassName)
 Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...
 
static void getRegisteredTypenames (Array< std::string > &typeNames)
 Retrieve all the typenames registered so far. More...
 
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. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
 Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
 Same as the other signature but the class name and property name are provided as two separate strings. More...
 
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. More...
 
static const std::string & getClassName ()
 Return the name of this class as a string; i.e., "Object". More...
 
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. More...
 
static bool getSerializeAllDefaults ()
 Report the value of the "serialize all defaults" flag. More...
 
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. More...
 
static void setDebugLevel (int newLevel)
 Set the amount of logging output. More...
 
static int getDebugLevel ()
 Get the current setting of debug level. More...
 
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. More...
 
static void RegisterType (const Object &defaultObject)
 OBSOLETE alternate name for registerType(). More...
 
static void RenameType (const std::string &oldName, const std::string &newName)
 OBSOLETE alternate name for renameType(). More...
 

Auto-generated functions

static RRAToolsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "RRATool". More...
 
void assign (Object &aObject) override
 This allows copy assignment in the Java GUI. More...
 
RRAToolclone () const override
 Create a new heap-allocated copy of the concrete object to which this Object refers. More...
 
const std::string & getConcreteClassName () const override
 Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...
 

Additional Inherited Members

- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized. More...
 
- Protected Member Functions inherited from OpenSim::AbstractTool
std::string getTimeString (const time_t &t) const
 Obtain a string of the provided time using asctime(). More...
 
- Protected Member Functions inherited from OpenSim::Object
 Object ()
 The default constructor is only for use by constructors of derived types. More...
 
 Object (const std::string &fileName, bool aUpdateFromXMLNode=true)
 Constructor from a file, to be called from other constructors that take a file as input. More...
 
 Object (const Object &source)
 Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly. More...
 
 Object (SimTK::Xml::Element &aElement)
 Construct the base class portion of an Object from a given Xml element that describes this Object. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
PropertyIndex getPropertyIndex (const std::string &name) const
 Look up a property by name and return its PropertyIndex if it is found. More...
 
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. More...
 
template<class T >
void checkPropertyValueIsPositive (const Property< T > &p) const
 Throw an exception if any of the property's values are not positive. More...
 
template<class T >
void checkPropertyValueIsInSet (const Property< T > &p, const std::set< T > &set) const
 Throw an exception if any of the property's values are not in the provided set. More...
 
template<class T >
void checkPropertyValueIsInRangeOrSet (const Property< T > &p, const T &lower, const T &upper, const std::set< T > &set) const
 Throw an exception if any of the property's values are neither in the provided range nor in the provided set. More...
 
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. More...
 
void clearObjectIsUpToDateWithProperties ()
 For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag. More...
 
void makeObjectNamesConsistentWithProperties ()
 Make sure the name of an object is consistent with its property type. More...
 
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. More...
 
void setDocument (XMLDocument *doc)
 Unconditionally set the XMLDocument associated with this object. More...
 
const XMLDocumentgetDocument () const
 Get a const pointer to the document (if any) associated with this object. More...
 
XMLDocumentupdDocument ()
 Get a writable pointer to the document (if any) associated with this object. More...
 
- Protected Attributes inherited from OpenSim::AbstractTool
Model_model
 Pointer to the model being investigated. More...
 
PropertyStr _modelFileProp
 Name of the xml file used to deserialize or construct a model. More...
 
std::string & _modelFile
 
PropertyBool _replaceForceSetProp
 Whether the force set included in the model file is replaced (if true) or appended to (if false) with force sets read in from file. More...
 
bool & _replaceForceSet
 
PropertyStrArray _forceSetFilesProp
 Names of the xml files used to construct a force set for the model. More...
 
Array< std::string > & _forceSetFiles
 
PropertyStr _resultsDirProp
 Directory used for writing results. More...
 
std::string & _resultsDir
 
PropertyInt _outputPrecisionProp
 Output precision. More...
 
int & _outputPrecision
 
PropertyDbl _tiProp
 Initial time for the investigation. More...
 
double & _ti
 
PropertyDbl _tfProp
 Final time for the investigation. More...
 
double & _tf
 
OpenSim::PropertyBool _solveForEquilibriumForAuxiliaryStatesProp
 A flag used to specify whether or not equilibrium is solved for the auxiliary states. More...
 
bool & _solveForEquilibriumForAuxiliaryStates
 
PropertyInt _maxStepsProp
 Maximum number of steps for the integrator. More...
 
int & _maxSteps
 
PropertyDbl _maxDTProp
 Maximum integration step size. More...
 
double & _maxDT
 
PropertyDbl _minDTProp
 Minimum integration step size. More...
 
double & _minDT
 
PropertyDbl _errorToleranceProp
 Integrator error tolerance. More...
 
double & _errorTolerance
 
PropertyObj _analysisSetProp
 Set of analyses to be run during the study. More...
 
AnalysisSet_analysisSet
 
PropertyObj _controllerSetProp
 
ControllerSet_controllerSet
 
bool _toolOwnsModel
 Whether the tool owns the model it operates on. More...
 
OpenSim::PropertyStr _externalLoadsFileNameProp
 Name of the file containing the external loads applied to the model. More...
 
std::string & _externalLoadsFileName
 
ExternalLoads _externalLoads
 ExternalLoads member for creating and editing applied external forces (e.g. More...
 
SimTK::ReferencePtr< ExternalLoads_modelExternalLoads
 
- Protected Attributes inherited from OpenSim::Object
PropertySet _propertySet
 OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. More...
 

Detailed Description

An abstract class for specifying the interface for an investigation.

Author
Frank C. Anderson
Version
1.0

Member Typedef Documentation

◆ Self

This typedef might be useful within the member functions of this class.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

Use this typedef to refer to the superclass of this class.

Avoid using the explicit type name of the superclass; this would introduce bugs if the superclass is changed.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

Constructor & Destructor Documentation

◆ ~RRATool()

virtual OpenSim::RRATool::~RRATool ( )
virtual

◆ RRATool() [1/3]

OpenSim::RRATool::RRATool ( )

◆ RRATool() [2/3]

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

◆ RRATool() [3/3]

OpenSim::RRATool::RRATool ( const RRATool aObject)

Member Function Documentation

◆ addNecessaryAnalyses()

void OpenSim::RRATool::addNecessaryAnalyses ( )

◆ adjustCOMToReduceResiduals() [1/2]

std::string OpenSim::RRATool::adjustCOMToReduceResiduals ( SimTK::State &  s,
const Storage qStore,
const Storage uStore 
)

◆ adjustCOMToReduceResiduals() [2/2]

std::string OpenSim::RRATool::adjustCOMToReduceResiduals ( const OpenSim::Array< double > &  aFAve,
const OpenSim::Array< double > &  aMAve 
)

◆ assign()

void OpenSim::RRATool::assign ( Object aObject)
inlineoverride

This allows copy assignment in the Java GUI.

Exceptions
Exceptionif the argument is not of type RRATool.

◆ clone()

RRATool* OpenSim::RRATool::clone ( ) const
inlineoverridevirtual

Create a new heap-allocated copy of the concrete object to which this Object refers.

It is up to the caller to delete the returned object when no longer needed. Every concrete object deriving from Object implements this pure virtual method automatically, via the declaration macro it invokes (e.g., OpenSim_DECLARE_CONCRETE_OBJECT()). Note that the concrete class overrides modify the return type to be a pointer to the concrete object; that still overrides the base class method because the return type is covariant with (that is, derives from) Object.

Implements OpenSim::AbstractTool.

◆ computeAverageResiduals() [1/2]

static void OpenSim::RRATool::computeAverageResiduals ( const Storage aForceStore,
OpenSim::Array< double > &  rFAve,
OpenSim::Array< double > &  rMAve 
)
static

◆ computeAverageResiduals() [2/2]

static void OpenSim::RRATool::computeAverageResiduals ( SimTK::State &  s,
Model aModel,
double  aTi,
double  aTf,
const Storage aStatesStore,
OpenSim::Array< double > &  rFAve,
OpenSim::Array< double > &  rMAve 
)
static

◆ getAdjustCOMToReduceResiduals()

bool OpenSim::RRATool::getAdjustCOMToReduceResiduals ( )
inline

◆ getAdjustedCOMBody()

const std::string& OpenSim::RRATool::getAdjustedCOMBody ( )
inline

◆ getClassName()

static const std::string& OpenSim::RRATool::getClassName ( )
inlinestatic

This returns "RRATool".

See getConcreteClassName() if you want the class name of the underlying concrete object instead.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ getConcreteClassName()

const std::string& OpenSim::RRATool::getConcreteClassName ( ) const
inlineoverridevirtual

Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.

This is the string that is used as the tag for this concrete object in an XML file. Every concrete class derived from Object automatically overrides this method via the declaration macro it uses. See getClassName() to get the class name of the referencing (possibly abstract) class rather than the concrete object.

See also
getClassName()

Implements OpenSim::AbstractTool.

◆ getConstraintsFileName()

const std::string& OpenSim::RRATool::getConstraintsFileName ( )
inline

◆ getDesiredKinematicsFileName()

const std::string& OpenSim::RRATool::getDesiredKinematicsFileName ( )
inline

◆ getDesiredPointsFileName()

const std::string& OpenSim::RRATool::getDesiredPointsFileName ( )
inline

◆ getExternalLoadsFileName()

const std::string& OpenSim::RRATool::getExternalLoadsFileName ( ) const
inline

◆ getForceStorage()

Storage& OpenSim::RRATool::getForceStorage ( )

◆ getLowpassCutoffFrequency()

double OpenSim::RRATool::getLowpassCutoffFrequency ( ) const
inline

◆ getOutputModelFileName()

const std::string& OpenSim::RRATool::getOutputModelFileName ( )
inline

◆ getTaskSetFileName()

const std::string& OpenSim::RRATool::getTaskSetFileName ( )
inline

◆ initializeControlSetUsingConstraints()

void OpenSim::RRATool::initializeControlSetUsingConstraints ( const ControlSet aRRAControlSet,
const ControlSet aControlConstraints,
ControlSet rControlSet 
)

◆ operator=()

RRATool& OpenSim::RRATool::operator= ( const RRATool aRRATool)

◆ run()

bool OpenSim::RRATool::run ( )
overridevirtual

Implements OpenSim::AbstractTool.

◆ safeDownCast()

static RRATool* OpenSim::RRATool::safeDownCast ( OpenSim::Object obj)
inlinestatic

For use in MATLAB and Python to access the concrete class.

Example: cObj = RRATool.safeDownCast(obj). This is equivalent to dynamic_cast<RRATool*>(obj) in C++.

◆ setAdjustCOMToReduceResiduals()

void OpenSim::RRATool::setAdjustCOMToReduceResiduals ( bool  aAdjust)
inline

◆ setAdjustedCOMBody()

void OpenSim::RRATool::setAdjustedCOMBody ( const std::string &  aBody)
inline

◆ setConstraintsFileName()

void OpenSim::RRATool::setConstraintsFileName ( const std::string &  aFileName)
inline

◆ setDesiredKinematicsFileName()

void OpenSim::RRATool::setDesiredKinematicsFileName ( const std::string &  aFileName)
inline

◆ setDesiredPointsFileName()

void OpenSim::RRATool::setDesiredPointsFileName ( const std::string &  aFileName)
inline

◆ setExternalLoadsFileName()

void OpenSim::RRATool::setExternalLoadsFileName ( const std::string &  aFileName)
inline

◆ setLowpassCutoffFrequency()

void OpenSim::RRATool::setLowpassCutoffFrequency ( double  aLowpassCutoffFrequency)
inline

◆ setOriginalForceSet()

void OpenSim::RRATool::setOriginalForceSet ( const ForceSet aForceSet)

◆ setOutputModelFileName()

void OpenSim::RRATool::setOutputModelFileName ( const std::string &  aFileName)
inline

◆ setTaskSetFileName()

void OpenSim::RRATool::setTaskSetFileName ( const std::string &  aFileName)
inline

◆ updateFromXMLNode()

void OpenSim::RRATool::updateFromXMLNode ( SimTK::Xml::Element &  objectElement,
int  versionNumber = -1 
)
overridevirtual

Use this method to deserialize an object from a SimTK::Xml::Element.

The element is assumed to be in the format consistent with the passed-in versionNumber. If there is a file attribute in objectElement it will be ignored; if you want it processed you should call readObjectFromXMLNodeOrFile() instead.

Reimplemented from OpenSim::AbstractTool.

◆ writeAdjustedModel()

void OpenSim::RRATool::writeAdjustedModel ( )

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