A concrete tool for performing forward dynamics simulations. More...

Inheritance diagram for OpenSim::ForwardTool:

Public Member Functions
virtual	~ForwardTool ()

	ForwardTool ()

	ForwardTool (const std::string &aFileName, bool aUpdateFromXMLNode=true, bool aLoadModel=true)

	ForwardTool (const ForwardTool &aObject)

ForwardTool &	operator= (const ForwardTool &aForwardTool)

void	updateFromXMLNode (SimTK::Xml::Element &aNode, int versionNumber=-1) override
	Use this method to deserialize an object from a SimTK::Xml::Element. More...

void	setManager (Manager &m)

const Manager &	getManager () const

const std::string &	getStatesFileName () const

void	setStatesFileName (const std::string &aFileName)

bool	getUseSpecifiedDt () const

void	setUseSpecifiedDt (bool aUseSpecifiedDt)

void	setPrintResultFiles (bool aToWrite)

bool	run () override

void	printResults ()
	(Deprecated) Use setPrintResultFiles(true) and run() instead. More...

void	loadStatesStorage (std::string &statesFileName, Storage *&rYStore) const

const std::string &	getParsingLog ()

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...

AbstractTool &	operator= (const AbstractTool &aTool)
	Assignment operator. More...

virtual void	setModel (Model &aModel)
	Set the model to be investigated. More...

virtual Model &	getModel () 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 ExternalLoads &	getExternalLoads () const

ExternalLoads &	updExternalLoads ()

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 AnalysisSet &	getAnalysisSet () const

AnalysisSet &	updAnalysisSet () const

const ControllerSet &	getControllerSet () const

ControllerSet &	updControllerSet () 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...

Object &	operator= (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 AbstractProperty &	getPropertyByIndex (int propertyIndex) const
	Get a const reference to a property by its index number, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByIndex (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 AbstractProperty &	getPropertyByName (const std::string &name) const
	Get a const reference to a property by its name, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByName (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 >
const Property< T > &	getPropertyByName (const std::string &name) 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...

template<class T >
Property< T > &	updPropertyByName (const std::string &name)
	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...

PropertySet &	getPropertySet ()
	OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...

const PropertySet &	getPropertySet () const

Public Types
typedef ForwardTool	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 double	Step (double t, double t0, double t1)

static double	SigmaUp (double tau, double to, double t)

static double	SigmaDn (double tau, double to, double t)

Static Public Member Functions inherited from OpenSim::AbstractTool
static AbstractTool *	safeDownCast (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 Object *	getDefaultInstanceOfType (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 Object *	newInstanceOfType (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 Object *	makeObjectFromFile (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 Object *	SafeCopy (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...

Protected Member Functions
void	setDesiredStatesForControllers (Storage &rYStore)

int	determineInitialTimeFromStatesStorage (double &rTI)

void	InitializeSpecifiedTimeStepping (Storage *aYStore, Manager &aManager)

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 *)
	Unconditionally set the XMLDocument associated with this object. More...

const XMLDocument *	getDocument () const
	Get a const pointer to the document (if any) associated with this object. More...

XMLDocument *	updDocument ()
	Get a writable pointer to the document (if any) associated with this object. More...

Protected Attributes
PropertyStr	_statesFileNameProp
	Name of the states file. More...

std::string &	_statesFileName

OpenSim::PropertyBool	_useSpecifiedDtProp
	If true, the time steps from the states file are used during current integration. More...

bool &	_useSpecifiedDt

Storage *	_yStore
	Storage for the input states. More...

bool	_printResultFiles
	Flag indicating whether or not to write to the results (GUI will set this to false). More...

Manager *	_manager
	pointer to the simulation Manager More...

std::string	_parsingLog

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...

Auto-generated functions
static ForwardTool *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "ForwardTool". More...

void	assign (Object &aObject) override
	This allows copy assignment in the Java GUI. More...

ForwardTool *	clone () 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...

Related Functions inherited from OpenSim::Object
#define	OpenSim_DECLARE_CONCRETE_OBJECT(ConcreteClass, SuperClass)
	Macro to be included as the first line of the class declaration for any non-templatized, concrete class that derives from OpenSim::Object. More...

#define	OpenSim_DECLARE_ABSTRACT_OBJECT(ConcreteClass, SuperClass)
	Macro to be included as the first line of the class declaration for any still-abstract class that derives from OpenSim::Object. More...

#define	OpenSim_DECLARE_CONCRETE_OBJECT_T(ConcreteClass, TArg, SuperClass)
	Macro to be included as the first line of the class declaration for any templatized, concrete class that derives from OpenSim::Object, like Set<T>. More...

#define	OpenSim_DECLARE_ABSTRACT_OBJECT_T(ConcreteClass, TArg, SuperClass)
	Macro to be included as the first line of the class declaration for any templatized, still-abstract class that derives from OpenSim::Object. More...

Detailed Description

A concrete tool for performing forward dynamics simulations.

Author: Frank C. Anderson

Version: 1.0

Member Typedef Documentation

◆ Self

typedef ForwardTool OpenSim::ForwardTool::Self

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

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

typedef AbstractTool OpenSim::ForwardTool::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

◆ ~ForwardTool()

virtual OpenSim::ForwardTool::~ForwardTool ( )

virtual

◆ ForwardTool() [1/3]

OpenSim::ForwardTool::ForwardTool ( )

◆ ForwardTool() [2/3]

OpenSim::ForwardTool::ForwardTool	(	const std::string &	aFileName,
		bool	aUpdateFromXMLNode = `true`,
		bool	aLoadModel = `true`
	)

◆ ForwardTool() [3/3]

OpenSim::ForwardTool::ForwardTool ( const ForwardTool & aObject )

Member Function Documentation

◆ assign()

void OpenSim::ForwardTool::assign ( Object & aObject )

inlineoverride

This allows copy assignment in the Java GUI.

Exceptions

Exception if the argument is not of type ForwardTool.

◆ clone()

ForwardTool* OpenSim::ForwardTool::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.

◆ determineInitialTimeFromStatesStorage()

int OpenSim::ForwardTool::determineInitialTimeFromStatesStorage ( double & rTI )

protected

◆ getClassName()

static const std::string& OpenSim::ForwardTool::getClassName ( )

inlinestatic

This returns "ForwardTool".

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::ForwardTool::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.

◆ getManager()

const Manager& OpenSim::ForwardTool::getManager ( ) const

◆ getParsingLog()

const std::string& OpenSim::ForwardTool::getParsingLog ( )

inline

◆ getStatesFileName()

const std::string& OpenSim::ForwardTool::getStatesFileName ( ) const

inline

◆ getUseSpecifiedDt()

bool OpenSim::ForwardTool::getUseSpecifiedDt ( ) const

inline

◆ InitializeSpecifiedTimeStepping()

void OpenSim::ForwardTool::InitializeSpecifiedTimeStepping	(	Storage *	aYStore,
		Manager &	aManager
	)

protected

◆ loadStatesStorage()

void OpenSim::ForwardTool::loadStatesStorage	(	std::string &	statesFileName,
		Storage *&	rYStore
	)		const

◆ operator=()

ForwardTool& OpenSim::ForwardTool::operator= ( const ForwardTool & aForwardTool )

◆ printResults()

void OpenSim::ForwardTool::printResults ( )

(Deprecated) Use setPrintResultFiles(true) and run() instead.

◆ run()

bool OpenSim::ForwardTool::run ( )

overridevirtual

Implements OpenSim::AbstractTool.

◆ safeDownCast()

static ForwardTool* OpenSim::ForwardTool::safeDownCast ( OpenSim::Object * obj )

inlinestatic

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

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

◆ setDesiredStatesForControllers()

void OpenSim::ForwardTool::setDesiredStatesForControllers ( Storage & rYStore )

protected

◆ setManager()

void OpenSim::ForwardTool::setManager ( Manager & m )

◆ setPrintResultFiles()

void OpenSim::ForwardTool::setPrintResultFiles ( bool aToWrite )

inline

◆ setStatesFileName()

void OpenSim::ForwardTool::setStatesFileName ( const std::string & aFileName )

inline

◆ setUseSpecifiedDt()

void OpenSim::ForwardTool::setUseSpecifiedDt ( bool aUseSpecifiedDt )

inline

◆ SigmaDn()

static double OpenSim::ForwardTool::SigmaDn	(	double	tau,
		double	to,
		double	t
	)

static

◆ SigmaUp()

static double OpenSim::ForwardTool::SigmaUp	(	double	tau,
		double	to,
		double	t
	)

static

◆ Step()

static double OpenSim::ForwardTool::Step	(	double	t,
		double	t0,
		double	t1
	)

static

◆ updateFromXMLNode()

void OpenSim::ForwardTool::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.

Member Data Documentation

◆ _manager

Manager* OpenSim::ForwardTool::_manager

protected

pointer to the simulation Manager

◆ _parsingLog

std::string OpenSim::ForwardTool::_parsingLog

protected

◆ _printResultFiles

bool OpenSim::ForwardTool::_printResultFiles

protected

Flag indicating whether or not to write to the results (GUI will set this to false).

◆ _statesFileName

std::string& OpenSim::ForwardTool::_statesFileName

protected

◆ _statesFileNameProp

PropertyStr OpenSim::ForwardTool::_statesFileNameProp

protected

Name of the states file.

The states file must at a minimum contain the initial states for a simulation. If a complete set of states is available, the time stamps can be used to specify the integration steps and corrective springs, which allow perturbations, can be added to the simulation.

◆ _useSpecifiedDt

bool& OpenSim::ForwardTool::_useSpecifiedDt

protected

◆ _useSpecifiedDtProp

OpenSim::PropertyBool OpenSim::ForwardTool::_useSpecifiedDtProp

protected

If true, the time steps from the states file are used during current integration.

◆ _yStore

Storage* OpenSim::ForwardTool::_yStore

protected

Storage for the input states.

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

OpenSim/Tools/ForwardTool.h

Public Member Functions

Public Types

Static Public Member Functions

Protected Member Functions

Protected Attributes

Auto-generated functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Self

◆ Super

Constructor & Destructor Documentation

◆ ~ForwardTool()

◆ ForwardTool() [1/3]

◆ ForwardTool() [2/3]

◆ ForwardTool() [3/3]

Member Function Documentation

◆ assign()

◆ clone()

◆ determineInitialTimeFromStatesStorage()

◆ getClassName()

◆ getConcreteClassName()

◆ getManager()

◆ getParsingLog()

◆ getStatesFileName()

◆ getUseSpecifiedDt()

◆ InitializeSpecifiedTimeStepping()

◆ loadStatesStorage()

◆ operator=()

◆ printResults()

◆ run()

◆ safeDownCast()

◆ setDesiredStatesForControllers()

◆ setManager()

◆ setPrintResultFiles()

◆ setStatesFileName()

◆ setUseSpecifiedDt()

◆ SigmaDn()

◆ SigmaUp()

◆ Step()

◆ updateFromXMLNode()

Member Data Documentation

◆ _manager

◆ _parsingLog

◆ _printResultFiles

◆ _statesFileName

◆ _statesFileNameProp

◆ _useSpecifiedDt

◆ _useSpecifiedDtProp

◆ _yStore