API  4.2
For MATLAB, Python, Java, and C++ users
OpenSim::AbstractTool Class Referenceabstract

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

Static Public Member Functions

Auto-generated functions
static AbstractToolsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. 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 <br>

static const std::string & getClassName ()
 This returns "AbstractTool"
More...
 
AbstractToolclone () 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...
 

Detailed Description

An abstract class for specifying the interface for an investigation.

Author
Frank C. Anderson
Version
1.0

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

◆ 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::ForwardTool, OpenSim::CMCTool, 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.

◆ 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::ForwardTool, OpenSim::CMCTool, 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
aBaseNameBasename file to which to print the data.
aDirDirectory to which to print the data into.
aDTTime interval between results (linear interpolation is used). If not included as an argument or negative, all time steps are printed without interpolation.
aExtensionExtension 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

◆ 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

◆ 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

◆ 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

◆ updExternalLoads()

ExternalLoads& OpenSim::AbstractTool::updExternalLoads ( )
inline

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