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

Inheritance diagram for OpenSim::AbstractTool:

Public Member Functions
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)

virtual bool	run ()=0

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 ()

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

virtual void	loadQStorage (const std::string &statesFileName, Storage &rQStore) const

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

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

const PropertySet &	getPropertySet () const

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

Protected Member Functions
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 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
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 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...

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

AbstractTool *	clone () const override=0
	Create a new heap-allocated copy of the concrete object to which this Object refers. More...

const std::string &	getConcreteClassName () const override=0
	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 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...

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

An abstract class for specifying the interface for an investigation.

Author: Frank C. Anderson

Version: 1.0

Member Typedef Documentation

◆ Self

typedef AbstractTool OpenSim::AbstractTool::Self

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

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

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

◆ ~AbstractTool()

virtual OpenSim::AbstractTool::~AbstractTool ( )

virtual

Destructor.

◆ AbstractTool() [1/3]

OpenSim::AbstractTool::AbstractTool ( )

Default constructor.

◆ AbstractTool() [2/3]

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

Construct from file, and an optional GuiModel.

The object is constructed from the root element of the XML document. The type of object is the tag name of the XML root element.

Parameters

aFileName	File name of the document.
aUpdateFromXMLNode

◆ AbstractTool() [3/3]

OpenSim::AbstractTool::AbstractTool ( const AbstractTool & aObject )

Copy constructor.

Copy constructors for all SimulationTools only copy the non-XML variable members of the object; that is, the object's DOMnode and XMLDocument are not copied but set to NULL. This is because the object and all its derived classes need to establish the correct connection to the XML document nodes. Thus the object needs to reconstruct based on the XML document, not the values of the object's member variables.

There are three proper ways to generate an XML document for a AbstractTool:

1) Construction based on XML file (

See also: AbstractTool(const char *aFileName)). In this case, the XML document is created by parsing the XML file.

2) Construction by AbstractTool(const XMLDocument *aDocument). This constructor explicitly requests construction based on an XML document. In this way the proper connection between an object's node and the corresponding node within the XML document is established. This constructor is a copy constructor of sorts because all essential AbstractTool member variables should be held within the XML document. The advantage of this style of construction is that nodes within the XML document, such as comments that may not have any associated AbstractTool member variable, are preserved.

3) A call to generateXMLDocument(). This method generates an XML document for the AbstractTool from scratch. Only the essential document nodes are created (that is, nodes that correspond directly to member variables.).

Parameters

aObject Object to be copied.

See also: AbstractTool(const XMLDocument *aDocument); AbstractTool(const char *aFileName)

Member Function Documentation

◆ addAnalysisSetToModel()

void OpenSim::AbstractTool::addAnalysisSetToModel ( )

Adds Analysis objects from analysis set to model.

NOTE: Makes copies of analyses. Also, both this tool and the model have ownership of their analysis objects, therefore making a copy is necessary so a single analysis won't be deleted twice.

To avoid leaking when the tool is run from the GUI, pointers to the model's copy of the analyses are kept around so that they can be removed at the end of tool execution. _analysisCopies is used to do this book keeping.

◆ addControllerSetToModel()

void OpenSim::AbstractTool::addControllerSetToModel ( )

◆ assign()

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

inlineoverride

This allows copy assignment in the Java GUI.

Exceptions

Exception if the argument is not of type AbstractTool.

◆ clone()

AbstractTool* OpenSim::AbstractTool::clone ( ) const

overridepure virtual

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

Implemented in OpenSim::RRATool, OpenSim::CMCTool, OpenSim::ForwardTool, and OpenSim::AnalyzeTool.

◆ createExternalLoads()

bool OpenSim::AbstractTool::createExternalLoads	(	const std::string &	externalLoadsFileName,
		Model &	model
	)

◆ getAnalysisSet()

const AnalysisSet& OpenSim::AbstractTool::getAnalysisSet ( ) const

inline

◆ getClassName()

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

inlinestatic

This returns "AbstractTool".

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::AbstractTool::getConcreteClassName ( ) const

overridepure virtual

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

Implemented in OpenSim::RRATool, OpenSim::CMCTool, OpenSim::ForwardTool, and OpenSim::AnalyzeTool.

◆ getControllerSet()

const ControllerSet& OpenSim::AbstractTool::getControllerSet ( ) const

inline

◆ getControlsFileName()

std::string OpenSim::AbstractTool::getControlsFileName ( ) const

◆ getErrorTolerance()

double OpenSim::AbstractTool::getErrorTolerance ( ) const

inline

◆ getExternalLoads()

const ExternalLoads& OpenSim::AbstractTool::getExternalLoads ( ) const

inline

◆ getExternalLoadsFileName()

const std::string& OpenSim::AbstractTool::getExternalLoadsFileName ( ) const

inline

◆ getFinalTime()

double OpenSim::AbstractTool::getFinalTime ( ) const

inline

◆ getForceSetFiles()

Array<std::string>& OpenSim::AbstractTool::getForceSetFiles ( )

inline

◆ getInitialTime()

double OpenSim::AbstractTool::getInitialTime ( ) const

inline

◆ getMaxDT()

double OpenSim::AbstractTool::getMaxDT ( ) const

inline

◆ getMaximumNumberOfSteps()

int OpenSim::AbstractTool::getMaximumNumberOfSteps ( ) const

inline

◆ getMinDT()

double OpenSim::AbstractTool::getMinDT ( ) const

inline

◆ getModel()

virtual Model& OpenSim::AbstractTool::getModel ( ) const

virtual

Get the model to be investigated.

◆ getModelFilename()

const std::string& OpenSim::AbstractTool::getModelFilename ( ) const

inline

◆ getNextAvailableForceName()

std::string OpenSim::AbstractTool::getNextAvailableForceName ( const std::string prefix = "Force" ) const

◆ getOutputPrecision()

int OpenSim::AbstractTool::getOutputPrecision ( ) const

inline

◆ getReplaceForceSet()

bool OpenSim::AbstractTool::getReplaceForceSet ( ) const

inline

◆ getResultsDir()

const std::string& OpenSim::AbstractTool::getResultsDir ( ) const

inline

Get Results Directory.

◆ getSolveForEquilibrium()

bool OpenSim::AbstractTool::getSolveForEquilibrium ( ) const

inline

◆ getStartTime()

double OpenSim::AbstractTool::getStartTime ( ) const

inline

◆ getTimeString()

std::string OpenSim::AbstractTool::getTimeString ( const time_t & t ) const

protected

Obtain a string of the provided time using asctime().

This function removes the newline that asctime() includes at the end of the string.

◆ getToolOwnsModel()

bool OpenSim::AbstractTool::getToolOwnsModel ( ) const

inline

◆ loadModel()

void OpenSim::AbstractTool::loadModel	(	const std::string &	aToolSetupFileName,
		ForceSet *	rOriginalForceSet = `0`
	)

Load and construct a model based on the property settings of this investigation.

◆ loadQStorage()

virtual void OpenSim::AbstractTool::loadQStorage	(	const std::string &	statesFileName,
		Storage &	rQStore
	)		const

virtual

◆ modelHasExternalLoads()

bool OpenSim::AbstractTool::modelHasExternalLoads ( )

inline

◆ operator=()

AbstractTool& OpenSim::AbstractTool::operator= ( const AbstractTool & aTool )

Assignment operator.

Returns: Reference to this object.

◆ printResults()

void OpenSim::AbstractTool::printResults	(	const std::string &	aBaseName,
		const std::string &	aDir = `""`,
		double	aDT = `-1.0`,
		const std::string &	aExtension = `".sto"`
	)

Print the results of the analysis.

Parameters

aBaseName	Basename file to which to print the data.
aDir	Directory to which to print the data into.
aDT	Time interval between results (linear interpolation is used). If not included as an argument or negative, all time steps are printed without interpolation.
aExtension	Extension for written files.

◆ removeAnalysisSetFromModel()

void OpenSim::AbstractTool::removeAnalysisSetFromModel ( )

◆ removeControllerSetFromModel()

void OpenSim::AbstractTool::removeControllerSetFromModel ( )

Remove Analysis objects that were added earlier from analysis set to model.

◆ removeExternalLoadsFromModel()

void OpenSim::AbstractTool::removeExternalLoadsFromModel ( )

◆ run()

virtual bool OpenSim::AbstractTool::run ( )

pure virtual

Implemented in OpenSim::CMCTool, OpenSim::RRATool, OpenSim::AnalyzeTool, and OpenSim::ForwardTool.

◆ safeDownCast()

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

inlinestatic

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

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

◆ setControlsFileName()

void OpenSim::AbstractTool::setControlsFileName ( const std::string & controlsFilename )

◆ setErrorTolerance()

void OpenSim::AbstractTool::setErrorTolerance ( double aErrorTolerance )

inline

◆ setExternalLoads()

void OpenSim::AbstractTool::setExternalLoads ( ExternalLoads & el )

inline

◆ setExternalLoadsFileName()

void OpenSim::AbstractTool::setExternalLoadsFileName ( const std::string & aFileName )

inline

◆ setFinalTime()

void OpenSim::AbstractTool::setFinalTime ( const double aFinalTime )

inline

◆ setForceSetFiles()

void OpenSim::AbstractTool::setForceSetFiles ( const Array< std::string > & aForceSetFiles )

inline

◆ setInitialTime()

void OpenSim::AbstractTool::setInitialTime ( const double aInitialTime )

inline

◆ setMaxDT()

void OpenSim::AbstractTool::setMaxDT ( double aMaxDT )

inline

◆ setMaximumNumberOfSteps()

void OpenSim::AbstractTool::setMaximumNumberOfSteps ( int aMaxSteps )

inline

◆ setMinDT()

void OpenSim::AbstractTool::setMinDT ( double aMinDT )

inline

◆ setModel()

virtual void OpenSim::AbstractTool::setModel ( Model & aModel )

virtual

Set the model to be investigated.

NOTE: setup() should have been called on the model prior to calling this method

◆ setModelFilename()

void OpenSim::AbstractTool::setModelFilename ( const std::string & aModelFile )

inline

Examples:: exampleHangingMuscle.cpp.

◆ setOutputPrecision()

void OpenSim::AbstractTool::setOutputPrecision ( int aPrecision )

inline

◆ setReplaceForceSet()

void OpenSim::AbstractTool::setReplaceForceSet ( bool aReplace )

inline

◆ setResultsDir()

void OpenSim::AbstractTool::setResultsDir ( const std::string & aString )

inline

◆ setSolveForEquilibrium()

void OpenSim::AbstractTool::setSolveForEquilibrium ( bool aSolve )

inline

◆ setStartTime()

void OpenSim::AbstractTool::setStartTime ( const double aStartTime )

inline

◆ setToolOwnsModel()

void OpenSim::AbstractTool::setToolOwnsModel ( const bool trueFalse )

inline

◆ updAnalysisSet()

AnalysisSet& OpenSim::AbstractTool::updAnalysisSet ( ) const

inline

Examples:: exampleHangingMuscle.cpp.

◆ updateFromXMLNode()

void OpenSim::AbstractTool::updateFromXMLNode	(	SimTK::Xml::Element &	objectElement,
		int	versionNumber
	)

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

Reimplemented in OpenSim::RRATool, and OpenSim::ForwardTool.

◆ updateModelForces()

void OpenSim::AbstractTool::updateModelForces	(	Model &	model,
		const std::string &	aToolSetupFileName,
		ForceSet *	rOriginalForceSet = `0`
	)

Update the forces applied to a model.

◆ updControllerSet()

ControllerSet& OpenSim::AbstractTool::updControllerSet ( ) const

inline

Examples:: exampleHangingMuscle.cpp.

◆ updExternalLoads()

ExternalLoads& OpenSim::AbstractTool::updExternalLoads ( )

inline

Member Data Documentation

◆ _analysisSet

AnalysisSet& OpenSim::AbstractTool::_analysisSet

protected

◆ _analysisSetProp

PropertyObj OpenSim::AbstractTool::_analysisSetProp

protected

Set of analyses to be run during the study.

◆ _controllerSet

ControllerSet& OpenSim::AbstractTool::_controllerSet

protected

◆ _controllerSetProp

PropertyObj OpenSim::AbstractTool::_controllerSetProp

protected

◆ _errorTolerance

double& OpenSim::AbstractTool::_errorTolerance

protected

◆ _errorToleranceProp

PropertyDbl OpenSim::AbstractTool::_errorToleranceProp

protected

Integrator error tolerance.

When the error is greater, the integrator step size is decreased.

◆ _externalLoads

ExternalLoads OpenSim::AbstractTool::_externalLoads

protected

ExternalLoads member for creating and editing applied external forces (e.g.

GRFS through the GUI) prior to running the Tool

◆ _externalLoadsFileName

std::string& OpenSim::AbstractTool::_externalLoadsFileName

protected

◆ _externalLoadsFileNameProp

OpenSim::PropertyStr OpenSim::AbstractTool::_externalLoadsFileNameProp

protected

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

◆ _forceSetFiles

Array<std::string>& OpenSim::AbstractTool::_forceSetFiles

protected

◆ _forceSetFilesProp

PropertyStrArray OpenSim::AbstractTool::_forceSetFilesProp

protected

Names of the xml files used to construct a force set for the model.

◆ _maxDT

double& OpenSim::AbstractTool::_maxDT

protected

◆ _maxDTProp

PropertyDbl OpenSim::AbstractTool::_maxDTProp

protected

Maximum integration step size.

◆ _maxSteps

int& OpenSim::AbstractTool::_maxSteps

protected

◆ _maxStepsProp

PropertyInt OpenSim::AbstractTool::_maxStepsProp

protected

Maximum number of steps for the integrator.

◆ _minDT

double& OpenSim::AbstractTool::_minDT

protected

◆ _minDTProp

PropertyDbl OpenSim::AbstractTool::_minDTProp

protected

Minimum integration step size.

◆ _model

Model* OpenSim::AbstractTool::_model

protected

Pointer to the model being investigated.

◆ _modelExternalLoads

SimTK::ReferencePtr<ExternalLoads> OpenSim::AbstractTool::_modelExternalLoads

protected

◆ _modelFile

std::string& OpenSim::AbstractTool::_modelFile

protected

◆ _modelFileProp

PropertyStr OpenSim::AbstractTool::_modelFileProp

protected

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

◆ _outputPrecision

int& OpenSim::AbstractTool::_outputPrecision

protected

◆ _outputPrecisionProp

PropertyInt OpenSim::AbstractTool::_outputPrecisionProp

protected

Output precision.

◆ _replaceForceSet

bool& OpenSim::AbstractTool::_replaceForceSet

protected

◆ _replaceForceSetProp

PropertyBool OpenSim::AbstractTool::_replaceForceSetProp

protected

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.

◆ _resultsDir

std::string& OpenSim::AbstractTool::_resultsDir

protected

◆ _resultsDirProp

PropertyStr OpenSim::AbstractTool::_resultsDirProp

protected

Directory used for writing results.

◆ _solveForEquilibriumForAuxiliaryStates

bool& OpenSim::AbstractTool::_solveForEquilibriumForAuxiliaryStates

protected

◆ _solveForEquilibriumForAuxiliaryStatesProp

OpenSim::PropertyBool OpenSim::AbstractTool::_solveForEquilibriumForAuxiliaryStatesProp

protected

A flag used to specify whether or not equilibrium is solved for the auxiliary states.

This often needs to be done for auxiliary states whose starting values are unknown (e.g., muscle fiber lengths).

◆ _tf

double& OpenSim::AbstractTool::_tf

protected

◆ _tfProp

PropertyDbl OpenSim::AbstractTool::_tfProp

protected

Final time for the investigation.

◆ _ti

double& OpenSim::AbstractTool::_ti

protected

◆ _tiProp

PropertyDbl OpenSim::AbstractTool::_tiProp

protected

Initial time for the investigation.

◆ _toolOwnsModel

bool OpenSim::AbstractTool::_toolOwnsModel

protected

Whether the tool owns the model it operates on.

Important for cleanup when done

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

OpenSim/Simulation/Model/AbstractTool.h

Public Member Functions

Public Types

Protected Member Functions

Protected Attributes

Auto-generated functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Self

◆ Super

Constructor & Destructor Documentation

◆ ~AbstractTool()

◆ AbstractTool() [1/3]

◆ AbstractTool() [2/3]

◆ AbstractTool() [3/3]

Member Function Documentation

◆ addAnalysisSetToModel()

◆ addControllerSetToModel()

◆ assign()

◆ clone()

◆ createExternalLoads()

◆ getAnalysisSet()

◆ getClassName()

◆ getConcreteClassName()

◆ getControllerSet()

◆ getControlsFileName()

◆ getErrorTolerance()

◆ getExternalLoads()

◆ getExternalLoadsFileName()

◆ getFinalTime()

◆ getForceSetFiles()

◆ getInitialTime()

◆ getMaxDT()

◆ getMaximumNumberOfSteps()

◆ getMinDT()

◆ getModel()

◆ getModelFilename()

◆ getNextAvailableForceName()

◆ getOutputPrecision()

◆ getReplaceForceSet()

◆ getResultsDir()

◆ getSolveForEquilibrium()

◆ getStartTime()

◆ getTimeString()

◆ getToolOwnsModel()

◆ loadModel()

◆ loadQStorage()

◆ modelHasExternalLoads()

◆ operator=()

◆ printResults()

◆ removeAnalysisSetFromModel()

◆ removeControllerSetFromModel()

◆ removeExternalLoadsFromModel()

◆ run()

◆ safeDownCast()

◆ setControlsFileName()

◆ setErrorTolerance()

◆ setExternalLoads()

◆ setExternalLoadsFileName()

◆ setFinalTime()

◆ setForceSetFiles()

◆ setInitialTime()

◆ setMaxDT()

◆ setMaximumNumberOfSteps()

◆ setMinDT()

◆ setModel()

◆ setModelFilename()

◆ setOutputPrecision()

◆ setReplaceForceSet()

◆ setResultsDir()

◆ setSolveForEquilibrium()

◆ setStartTime()

◆ setToolOwnsModel()

◆ updAnalysisSet()

◆ updateFromXMLNode()

◆ updateModelForces()

◆ updControllerSet()

◆ updExternalLoads()

Member Data Documentation

◆ _analysisSet