A concrete class representing a path for muscles, ligaments, etc., based on Function objects. More...

Inheritance diagram for OpenSim::FunctionBasedPath:

OpenSim Properties, Sockets, Outputs, Inputs
Properties (list)
std::string	coordinate_paths
	"The list of paths to the model coordinates that are used as " "arguments to the length, lengthening speed, and moment arm " "functions. You must provide a least one coordinate path, and " "the order of the paths must match the order of the arguments " "passed to `length_function` (and `moment_arm_functions` and " "`lengthening_speed_function`, if provided)." More...

Function	moment_arm_functions
	"(Optional) The list of OpenSim::Function objects that compute the " "moment arms of the path as a function of the coordinate values. " "The function arguments must match the order in " "`coordinate_paths`." More...

Properties (optional)
Function	length_function
	"(Required) The OpenSim::Function object that computes the length " "of the path as a function of the coordinate values. The function " "arguments must match the order in `coordinate_paths`." More...

Function	lengthening_speed_function
	"(Optional) The OpenSim::Function object that computes the speed " "of the path as a function of the coordinate values and speeds. " "The function arguments must be the coordinate values followed by " "coordinate speeds, both matching the order in " "`coordinate_paths`." More...

OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::AbstractGeometryPath
double	length
	Provides the value of getLength() and is available at stage SimTK::Stage::Position . More...

double	lengthening_speed
	Provides the value of getLengtheningSpeed() and is available at stage SimTK::Stage::Velocity . More...

Appearance	Appearance
	"Default appearance attributes for this AbstractGeometryPath." More...

OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::Component
Component	components
	"List of components that this component owns and serializes." More...

Public Member Functions
	FunctionBasedPath ()

void	setCoordinatePaths (const std::vector< std::string > &coordinatePaths)
	Set the list of paths to the model coordinate that are used as arguments to the length and, if provided, lengthening speed and moment functions. More...

void	appendCoordinatePath (const std::string &coordinatePath)

std::vector< std::string >	getCoordinatePaths () const

void	setLengthFunction (const Function &lengthFunction)
	Set the function that computes the length of the path as a function of the coordinate values. More...

const Function &	getLengthFunction () const

void	setMomentArmFunctions (const std::vector< Function > &momentArmFunctions)
	Set the list of functions that compute the moment arms of the path as a function of the coordinate values. More...

void	appendMomentArmFunction (const Function &momentArmFunction)

const Function &	getMomentArmFunction (const std::string &coordinatePath) const

const SimTK::Vector &	getMomentArms (const SimTK::State &s) const

void	setLengtheningSpeedFunction (const Function &speedFunction)
	Set the function that computes the speed of the path as a function of the coordinate values and speeds. More...

const Function &	getLengtheningSpeedFunction () const

double	getLength (const SimTK::State &s) const override
	Get the current length of the path. More...

double	getLengtheningSpeed (const SimTK::State &s) const override
	Get the lengthening speed of the path. More...

double	computeMomentArm (const SimTK::State &s, const Coordinate &coord) const override

void	addInEquivalentForces (const SimTK::State &state, const double &tension, SimTK::Vector_< SimTK::SpatialVec > &bodyForces, SimTK::Vector &mobilityForces) const override
	Add in the equivalent body and generalized forces to be applied to the multibody system resulting from a tension along the AbstractGeometryPath. More...

bool	isVisualPath () const override
	Return whether or not a path can be visualized. More...

Property-related functions
const std::string &	get_coordinate_paths (int i) const
	Get the value of the i-th element of the coordinate_paths property. More...

std::string &	upd_coordinate_paths (int i)
	Get a writable reference to the i-th element of the coordinate_paths property. More...

void	set_coordinate_paths (int i, const std::string &value)
	Set the value of the i-th element of coordinate_paths property. More...

int	append_coordinate_paths (const std::string &value)
	Append an element to the coordinate_paths property. More...

const Function &	get_length_function () const
	Get the value of the length_function property. More...

Function &	upd_length_function ()
	Get a writable reference to the length_function property. More...

void	set_length_function (const Function &value)
	Set the value of the length_function property. More...

const Function &	get_moment_arm_functions (int i) const
	Get the value of the i-th element of the moment_arm_functions property. More...

Function &	upd_moment_arm_functions (int i)
	Get a writable reference to the i-th element of the moment_arm_functions property. More...

void	set_moment_arm_functions (int i, const Function &value)
	Set the value of the i-th element of moment_arm_functions property. More...

int	append_moment_arm_functions (const Function &value)
	Append an element to the moment_arm_functions property. More...

const Function &	get_lengthening_speed_function () const
	Get the value of the lengthening_speed_function property. More...

Function &	upd_lengthening_speed_function ()
	Get a writable reference to the lengthening_speed_function property. More...

void	set_lengthening_speed_function (const Function &value)
	Set the value of the lengthening_speed_function property. More...

Public Member Functions inherited from OpenSim::AbstractGeometryPath
	AbstractGeometryPath ()

	~AbstractGeometryPath () noexcept override

	AbstractGeometryPath (const AbstractGeometryPath &)

AbstractGeometryPath &	operator= (const AbstractGeometryPath &)

	AbstractGeometryPath (AbstractGeometryPath &&other)

AbstractGeometryPath &	operator= (AbstractGeometryPath &&other)

const SimTK::Vec3 &	getDefaultColor () const
	Get the default color of the path. More...

void	setDefaultColor (const SimTK::Vec3 &color)
	Set the default color of the path. More...

virtual SimTK::Vec3	getColor (const SimTK::State &s) const
	Get the current color of the path. More...

virtual void	setColor (const SimTK::State &s, const SimTK::Vec3 &color) const
	Set the current color of the path. More...

double	getPreScaleLength (const SimTK::State &s) const
	Get the current length of the path, before the last set of scaling operations were applied to it. More...

void	setPreScaleLength (const SimTK::State &s, double preScaleLength)

const Appearance &	get_Appearance () const
	Get the value of the Appearance property. More...

Appearance &	upd_Appearance ()
	Get a writable reference to the Appearance property. More...

void	set_Appearance (const Appearance &value)
	Set the value of the Appearance property. More...

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

Public Member Functions inherited from OpenSim::ModelComponent
	ModelComponent ()
	Default constructor. More...

	ModelComponent (const std::string &aFileName, bool aUpdateFromXMLNode=true)
	Construct ModelComponent from an XML file. More...

	ModelComponent (SimTK::Xml::Element &aNode)
	Construct ModelComponent from a specific node in an XML document. More...

virtual	~ModelComponent ()
	Destructor is virtual to allow concrete model component cleanup. More...

void	connectToModel (Model &model)
	Connect this ModelComponent to its aggregate- a Model. More...

const Model &	getModel () const
	Get a const reference to the Model this component is part of. More...

Model &	updModel ()
	Get a modifiable reference to the Model this component is part of. More...

bool	hasModel () const
	Does this ModelComponent have a Model associated with it? More...

void	preScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Perform any computations that must occur before ModelComponent::scale() is invoked on all ModelComponents in the Model. More...

void	scale (const SimTK::State &s, const ScaleSet &scaleSet)
	Scale the ModelComponent. More...

void	postScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Perform any computations that must occur after ModelComponent::scale() has been invoked on all ModelComponents in the Model. More...

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

Public Member Functions inherited from OpenSim::Component
	Component ()
	Default constructor. More...

	Component (const std::string &aFileName, bool aUpdateFromXMLNode=true)
	Construct Component from an XML file. More...

	Component (SimTK::Xml::Element &aNode)
	Construct Component from a specific node in an XML document. More...

	Component (const Component &)=default
	Use default copy constructor and assignment operator. More...

Component &	operator= (const Component &)=default

virtual	~Component ()=default
	Destructor is virtual to allow concrete Component to cleanup. More...

virtual void	generateDecorations (bool fixed, const ModelDisplayHints &hints, const SimTK::State &state, SimTK::Array_< SimTK::DecorativeGeometry > &appendToThis) const
	Optional method for generating arbitrary display geometry that reflects this Component at the specified state. More...

const SimTK::MultibodySystem &	getSystem () const
	Get the underlying MultibodySystem that this component is connected to. More...

bool	hasSystem () const
	Check if this component has an underlying MultibodySystem. More...

bool	isComponentInOwnershipTree (const Component *component) const
	Does the provided component already exist anywhere in the ownership tree (not just subcomponents of this component)? More...

void	addComponent (Component *subcomponent)
	Add a Component (as a subcomponent) of this component. More...

template<typename T = Component>
ComponentList< const T >	getComponentList () const
	Get an iterator through the underlying subcomponents that this component is composed of. More...

template<typename T = Component>
ComponentList< T >	updComponentList ()
	Similar to getComponentList(), except the resulting list allows one to modify the components. More...

template<typename T = Component>
unsigned	countNumComponents () const
	Uses getComponentList<T>() to count the number of underlying subcomponents of the specified type. More...

std::string	getAbsolutePathString () const
	Get the complete (absolute) pathname for this Component to its ancestral Component, which is the root of the tree to which this Component belongs. More...

ComponentPath	getAbsolutePath () const
	Return a ComponentPath of the absolute path of this Component. More...

std::string	getRelativePathString (const Component &wrt) const
	Get the relative path of this Component with respect to another Component, as a string. More...

ComponentPath	getRelativePath (const Component &wrt) const
	Get the relative path of this Component with respect to another Component. More...

bool	hasComponent (const std::string &pathname) const
	Query if there is a component (of any type) at the specified path name. More...

template<class C = Component>
bool	hasComponent (const std::string &pathname) const
	Query if there is a component of a given type at the specified path name. More...

template<class C = Component>
const C &	getComponent (const std::string &pathname) const
	Get a unique subcomponent of this Component by its path name and type 'C'. More...

template<class C = Component>
const C &	getComponent (const ComponentPath &pathname) const

const Component &	getComponent (const std::string &pathname) const
	Similar to the templatized getComponent(), except this returns the component as the generic Component type. More...

template<class C = Component>
C &	updComponent (const std::string &name)
	Get a writable reference to a subcomponent. More...

template<class C = Component>
C &	updComponent (const ComponentPath &name)

Component &	updComponent (const std::string &pathname)
	Similar to the templatized updComponent(), except this returns the component as the generic Component type. More...

unsigned	printComponentsMatching (const std::string &substring) const
	Print a list to the console of all components whose absolute path name contains the given string. More...

int	getNumStateVariables () const
	Get the number of "continuous" state variables maintained by the Component and its subcomponents. More...

Array< std::string >	getStateVariableNames () const
	Get the names of continuous state variables maintained by the Component and its subcomponents. More...

Array< std::string >	getDiscreteVariableNames () const
	Get the names of discrete state variables maintained by the Component and its subcomponents. More...

Array< std::string >	getModelingOptionNames () const
	Get the names of the modeling options maintained by the Component and its subcomponents. More...

void	finalizeFromProperties ()
	Define a Component's internal data members and structure according to its properties. More...

void	finalizeConnections (Component &root)
	Satisfy the Component's connections specified by its Sockets and Inputs. More...

void	clearConnections ()
	Disconnect/clear this Component from its aggregate component. More...

void	addToSystem (SimTK::MultibodySystem &system) const
	Have the Component add itself to the underlying computational System. More...

void	initStateFromProperties (SimTK::State &state) const
	Initialize Component's state variable values from its properties. More...

void	setPropertiesFromState (const SimTK::State &state)
	Set Component's properties given a state. More...

int	getNumSockets () const
	Get the number of Sockets in this Component. More...

std::vector< std::string >	getSocketNames () const
	Collect and return the names of the sockets in this component. More...

template<typename T >
const T &	getConnectee (const std::string &name) const
	Get the "connectee" object that the Component's Socket is bound to. More...

template<typename T >
const T &	getConnectee (const std::string &name, int index) const
	Get the "connectee" object at the provided index that the Component's Socket is bound to. More...

const Object &	getConnectee (const std::string &name) const
	Get the connectee as an Object. More...

const Object &	getConnectee (const std::string &name, int index) const
	Get the connectee at the provided index as an Object. More...

const AbstractSocket *	tryGetSocket (const std::string &name) const
	Returns a pointer to the AbstractSocket with a given socket name, or `nullptr` if the socket with the given name does not exist on the component. More...

const AbstractSocket &	getSocket (const std::string &name) const
	Get an AbstractSocket for the given socket name. More...

const AbstractSocket *	tryUpdSocket (const std::string &name)
	Returns a writable pointer to the AbstractSocket with a given socket name, or `nullptr` if the socket with the given name does not exist on the component. More...

AbstractSocket &	updSocket (const std::string &name)
	Get a writable reference to the AbstractSocket for the given socket name. More...

template<typename T >
const Socket< T > &	getSocket (const std::string &name) const
	Get a const reference to the concrete Socket provided by this Component by name. More...

template<typename T >
Socket< T > &	updSocket (const std::string &name)
	Get a writable reference to the concrete Socket provided by this Component by name. More...

int	getModelingOption (const SimTK::State &state, const std::string &path) const
	Based on a specified path, get the value of a modeling option. More...

int	getModelingOption (const SimTK::State &state, const ComponentPath &path) const

void	setModelingOption (SimTK::State &state, const std::string &path, int flag) const
	Based on a specified path, set the value of a modeling option. More...

void	setModelingOption (SimTK::State &state, const ComponentPath &path, int flag) const

template<typename T >
const T &	getInputValue (const SimTK::State &state, const std::string &name) const
	Get the Input value that this component is dependent on. More...

template<typename T >
const T &	getOutputValue (const SimTK::State &state, const std::string &name) const
	Get the Output value provided by this Component by name. More...

double	getStateVariableValue (const SimTK::State &state, const std::string &name) const
	Get the value of a state variable allocated by this Component. More...

double	getStateVariableValue (const SimTK::State &state, const ComponentPath &path) const
	Get the value of a state variable allocated by this Component. More...

void	setStateVariableValue (SimTK::State &state, const std::string &name, double value) const
	Set the value of a state variable allocated by this Component by name. More...

SimTK::Vector	getStateVariableValues (const SimTK::State &state) const
	Get all values of the state variables allocated by this Component. More...

void	setStateVariableValues (SimTK::State &state, const SimTK::Vector &values) const
	Set all values of the state variables allocated by this Component. More...

double	getStateVariableDerivativeValue (const SimTK::State &state, const std::string &name) const
	Get the value of a state variable derivative computed by this Component. More...

double	getStateVariableDerivativeValue (const SimTK::State &state, const ComponentPath &path) const
	Get the value of a state variable derivative computed by this Component. More...

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

int	getNumInputs () const
	Access the number of Inputs that this component has. More...

int	getNumOutputs () const
	Access the number of Outputs that this component has. More...

std::vector< std::string >	getInputNames () const
	Collect and return the names of Inputs in this component as an std::vector. More...

std::vector< std::string >	getOutputNames () const
	Collect and return the names of Outputs in this component as an std::vector. More...

const AbstractInput &	getInput (const std::string &name) const
	Get an Input provided by this Component by name. More...

AbstractInput &	updInput (const std::string &name)
	Get a writable reference to an Input provided by this Component by name. More...

template<typename T >
const Input< T > &	getInput (const std::string &name) const
	Get a concrete Input that you can directly ask for its values. More...

const AbstractOutput *	tryGetOutput (const std::string &name) const
	If it exists on the component, returns a pointer to the named `Output`; otherwise, returns a `nullptr`. More...

const AbstractOutput &	getOutput (const std::string &name) const
	Get the Output provided by this Component by name. More...

AbstractOutput *	tryUpdOutput (const std::string &name)
	If it exists on the component returns a writable pointer to the named `Output`; otherwise, returns a `nullptr` More...

AbstractOutput &	updOutput (const std::string &name)
	Get a writable reference to an Output provided by this Component by name. More...

SimTK::IteratorRange< OutputConstIterator >	getOutputs () const
	Iterate through all Outputs of this component. 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 FunctionBasedPath	Self
	This typedef might be useful within the member functions of this class. More...

typedef AbstractGeometryPath	Super
	Use this typedef to refer to the superclass of this class. More...

Public Types inherited from OpenSim::AbstractGeometryPath
typedef AbstractGeometryPath	Self
	This typedef might be useful within the member functions of this class. More...

typedef ModelComponent	Super
	Use this typedef to refer to the superclass of this class. More...

Public Types inherited from OpenSim::ModelComponent
typedef ModelComponent	Self
	This typedef might be useful within the member functions of this class. More...

typedef Component	Super
	Use this typedef to refer to the superclass of this class. More...

Public Types inherited from OpenSim::Component
typedef Component	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...

typedef std::map< std::string, SimTK::ClonePtr< AbstractOutput > >::const_iterator	OutputConstIterator
	Define OutputConstIterator for convenience. More...

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

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

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

FunctionBasedPath *	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 Member Functions inherited from OpenSim::AbstractGeometryPath
static AbstractGeometryPath *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

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

Static Public Member Functions inherited from OpenSim::ModelComponent
static ModelComponent *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

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

Static Public Member Functions inherited from OpenSim::Component
static Component *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

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

Static Public Attributes inherited from OpenSim::Object
static const std::string	DEFAULT_NAME
	Name used for default objects when they are serialized. More...

Protected Member Functions inherited from OpenSim::ModelComponent
const SimTK::Vec3 &	getScaleFactors (const ScaleSet &scaleSet, const Frame &frame) const
	Get the scale factors corresponding to the base OpenSim::Body of the specified Frame. More...

virtual void	extendPreScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Perform any computations that must occur before ModelComponent::scale() is invoked on all ModelComponents in the Model. More...

virtual void	extendScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Scale the ModelComponent. More...

virtual void	extendPostScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Perform any computations that must occur after ModelComponent::scale() has been invoked on all ModelComponents in the Model. More...

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

void	extendFinalizeFromProperties () override

Protected Member Functions inherited from OpenSim::Component
const Component &	get_components (int i) const
	Get the value of the i-th element of the components property. More...

Component &	upd_components (int i)
	Get a writable reference to the i-th element of the components property. More...

void	set_components (int i, const Component &value)
	Set the value of the i-th element of components property. More...

int	append_components (const Component &value)
	Append an element to the components property. 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 inherited from OpenSim::ModelComponent
SimTK::ReferencePtr< Model >	_model
	The model this component belongs to. More...

Protected Attributes inherited from OpenSim::Object
PropertySet	_propertySet
	OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. More...

Static Protected Attributes inherited from OpenSim::ModelComponent
static const SimTK::Vec3	InvalidScaleFactors
	Returned by getScaleFactors() if the ScaleSet does not contain scale factors for the base Body associated with the specified Frame. 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 class representing a path for muscles, ligaments, etc., based on Function objects.

This class can be used when efficient computations of path length, lengthening speed, and moment arms are a priority (e.g., a direct collocation problem).

Each instance of this class requires both a list of model coordinates that the path is dependent on and a function, \( l(q) \), that computes the length of the path as a function of the coordinate values, \( q \). Optionally, functions can be provided to compute the moment arms of the path as a function of the coordinate values and a function that computes the speed of the path as a function of the coordinate values and speeds.

If the moment arm and/or speed functions are not provided, they will be computed from the length function based on van den Bogert et al. (2013) and Meyer et al. (2017):

\[ r_i = -\frac{\partial l}{\partial q_i} \quad \forall q_i \in Q \]

\[ \dot{l} = \frac{dl}{dt} = \sum_i \frac{\partial l}{\partial q_i} \frac{dq_i}{dt} = \sum_i -r_i \dot{q}_i \]

Where,

\( r_i \): the moment arm of the path with respect to coordinate \(q_i\).
\( l \): the length of the path.
\( \dot{l} \): the lengthening speed of the path.
\( q_i \): the i-th coordinate value.
\( \dot{q}_i \): the i-th coordinate value derivative.
\( Q \): the set of all coordinates.

Note: The moment arm expression above assumes that all constraints in the model are workless (i.e., no MovingPathPoints). Other path types (e.g., GeometryPath) compute moment arms based on the generalized force applied to joint given a unit force along the path, which does not rely on this assumption (see MomentArmSolver). Please keep this in mind when providing the path functions. See Sherman et al. (2013) for more details.; \( \dot{q}_i \) is usually, but not necessarily, the same as the generalized speed of the coordinate, \( u_i \) (e.g., see BallJoint). Please keep this in mind when providing a speed function. See Sherman et al. (2013) for more details.

The length function and (if provided) the moment arm functions must have the same number of arguments as the number of coordinates, where the order of the arguments matches the order in the coordinates property. Each moment arm function corresponds to a single coordinate, and the order of the functions in the moment_arm_functions property must match the order in coordinates. The speed function (if provided) must have twice as many arguments as the number of coordinates, where the first half of the arguments are the coordinate values and the second half are the coordinate speeds. Again, the order of the value and speed arguments must match the order in the coordinates property.

Note: The forces applied to the model by the path are computed by multiplying the tension in the path by the moment arms. Therefore, this class only applies mobility (i.e., generalized) forces to the model.

References

[1] Meyer AJ, Patten C, Fregly BJ (2017) "Lower extremity EMG-driven modeling of walking with automated adjustment of musculoskeletal geometry." PLoS ONE 12(7): e0179698. https://doi.org/10.1371/journal.pone.0179698
[2] van den Bogert, A.J., Geijtenbeek, T., Even-Zohar, O. et al. (2013) "A real-time system for biomechanical analysis of human movement and muscle function." Med Biol Eng Comput 51, 1069–1077 (2013). https://doi.org/10.1007/s11517-013-1076-z
[3] Sherman MA, Seth A, Delp SL. (2013) "What is a Moment Arm? Calculating Muscle Effectiveness in Biomechanical Models Using Generalized Coordinates." ASME. International Design Engineering Technical Conferences and Computers and Information in Engineering Conference, Volume 7B: 9th International Conference on Multibody Systems, Nonlinear Dynamics, and Control.

Member Typedef Documentation

◆ Self

typedef FunctionBasedPath OpenSim::FunctionBasedPath::Self

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

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

typedef AbstractGeometryPath OpenSim::FunctionBasedPath::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

◆ FunctionBasedPath()

OpenSim::FunctionBasedPath::FunctionBasedPath ( )

Member Function Documentation

◆ addInEquivalentForces()

void OpenSim::FunctionBasedPath::addInEquivalentForces	(	const SimTK::State &	state,
		const double &	tension,
		SimTK::Vector_< SimTK::SpatialVec > &	bodyForces,
		SimTK::Vector &	mobilityForces
	)		const

overridevirtual

Add in the equivalent body and generalized forces to be applied to the multibody system resulting from a tension along the AbstractGeometryPath.

Parameters

	state	state used to evaluate forces
[in]	tension	scalar of the applied (+ve) tensile force
[in,out]	bodyForces	Vector of forces (SpatialVec's) on bodies
[in,out]	mobilityForces	Vector of generalized forces

Implements OpenSim::AbstractGeometryPath.

◆ append_coordinate_paths()

int OpenSim::FunctionBasedPath::append_coordinate_paths ( const std::string & value )

inline

Append an element to the coordinate_paths property.

◆ append_moment_arm_functions()

int OpenSim::FunctionBasedPath::append_moment_arm_functions ( const Function & value )

inline

Append an element to the moment_arm_functions property.

◆ appendCoordinatePath()

void OpenSim::FunctionBasedPath::appendCoordinatePath ( const std::string & coordinatePath )

◆ appendMomentArmFunction()

void OpenSim::FunctionBasedPath::appendMomentArmFunction ( const Function & momentArmFunction )

◆ assign()

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

inlineoverride

This allows copy assignment in the Java GUI.

Exceptions

Exception if the argument is not of type FunctionBasedPath.

◆ clone()

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

◆ computeMomentArm()

double OpenSim::FunctionBasedPath::computeMomentArm	(	const SimTK::State &	s,
		const Coordinate &	coord
	)		const

overridevirtual

Note: This must check if the path is dependent on the provided coordinate, which requires a search through the list of coordinates. To retrieve the moment arms directly from the cache variable in the SimTK::State, use getMomentArms() instead.

Implements OpenSim::AbstractGeometryPath.

◆ get_coordinate_paths()

const std::string& OpenSim::FunctionBasedPath::get_coordinate_paths ( int i ) const

inline

Get the value of the i-th element of the coordinate_paths property.

◆ get_length_function()

const Function& OpenSim::FunctionBasedPath::get_length_function ( ) const

inline

Get the value of the length_function property.

◆ get_lengthening_speed_function()

const Function& OpenSim::FunctionBasedPath::get_lengthening_speed_function ( ) const

inline

Get the value of the lengthening_speed_function property.

◆ get_moment_arm_functions()

const Function& OpenSim::FunctionBasedPath::get_moment_arm_functions ( int i ) const

inline

Get the value of the i-th element of the moment_arm_functions property.

◆ getClassName()

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

inlinestatic

This returns "FunctionBasedPath".

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::FunctionBasedPath::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::AbstractGeometryPath.

◆ getCoordinatePaths()

std::vector<std::string> OpenSim::FunctionBasedPath::getCoordinatePaths ( ) const

◆ getLength()

double OpenSim::FunctionBasedPath::getLength ( const SimTK::State & s ) const

overridevirtual

Get the current length of the path.

Internally, this may use a variety of methods to figure out how long the path is, such as using spline-fits, or computing the distance between points in space. It is up to concrete implementations (e.g., GeometryPath) to provide a relevant implementation.

Implements OpenSim::AbstractGeometryPath.

◆ getLengtheningSpeed()

double OpenSim::FunctionBasedPath::getLengtheningSpeed ( const SimTK::State & s ) const

overridevirtual

Get the lengthening speed of the path.

Internally, this may use a variety of methods to figure out the lengthening speed. It might use the finite difference between two lengths, or an analytic solution, or always return 0.0. It is up to concrete implementations (e.g., GeometryPath) to provide a relevant implementation.

Implements OpenSim::AbstractGeometryPath.

◆ getLengtheningSpeedFunction()

const Function& OpenSim::FunctionBasedPath::getLengtheningSpeedFunction ( ) const

◆ getLengthFunction()

const Function& OpenSim::FunctionBasedPath::getLengthFunction ( ) const

◆ getMomentArmFunction()

const Function& OpenSim::FunctionBasedPath::getMomentArmFunction ( const std::string & coordinatePath ) const

◆ getMomentArms()

const SimTK::Vector& OpenSim::FunctionBasedPath::getMomentArms ( const SimTK::State & s ) const

◆ isVisualPath()

bool OpenSim::FunctionBasedPath::isVisualPath ( ) const

inlineoverridevirtual

Return whether or not a path can be visualized.

Concrete implementations may be visualizable (e.g., GeometryPath) or they may not be and therefore must provide a relevant implementation.

Implements OpenSim::AbstractGeometryPath.

◆ safeDownCast()

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

inlinestatic

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

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

◆ set_coordinate_paths()

void OpenSim::FunctionBasedPath::set_coordinate_paths	(	int	i,
		const std::string &	value
	)

inline

Set the value of the i-th element of coordinate_paths property.

◆ set_length_function()

void OpenSim::FunctionBasedPath::set_length_function ( const Function & value )

inline

Set the value of the length_function property.

◆ set_lengthening_speed_function()

void OpenSim::FunctionBasedPath::set_lengthening_speed_function ( const Function & value )

inline

Set the value of the lengthening_speed_function property.

◆ set_moment_arm_functions()

void OpenSim::FunctionBasedPath::set_moment_arm_functions	(	int	i,
		const Function &	value
	)

inline

Set the value of the i-th element of moment_arm_functions property.

◆ setCoordinatePaths()

void OpenSim::FunctionBasedPath::setCoordinatePaths ( const std::vector< std::string > & coordinatePaths )

Set the list of paths to the model coordinate that are used as arguments to the length and, if provided, lengthening speed and moment functions.

The order of the coordinates must match the order of the function arguments.

◆ setLengtheningSpeedFunction()

void OpenSim::FunctionBasedPath::setLengtheningSpeedFunction ( const Function & speedFunction )

Set the function that computes the speed of the path as a function of the coordinate values and speeds.

The function must have the same number of arguments as the number of coordinate values and speeds.

◆ setLengthFunction()

void OpenSim::FunctionBasedPath::setLengthFunction ( const Function & lengthFunction )

Set the function that computes the length of the path as a function of the coordinate values.

The function must have the same number of arguments as the number of coordinates.

◆ setMomentArmFunctions()

void OpenSim::FunctionBasedPath::setMomentArmFunctions ( const std::vector< Function > & momentArmFunctions )

Set the list of functions that compute the moment arms of the path as a function of the coordinate values.

The order of the functions must match the order of the coordinates.

◆ upd_coordinate_paths()

std::string& OpenSim::FunctionBasedPath::upd_coordinate_paths ( int i )

inline

Get a writable reference to the i-th element of the coordinate_paths property.

◆ upd_length_function()

Function& OpenSim::FunctionBasedPath::upd_length_function ( )

inline

Get a writable reference to the length_function property.

◆ upd_lengthening_speed_function()

Function& OpenSim::FunctionBasedPath::upd_lengthening_speed_function ( )

inline

Get a writable reference to the lengthening_speed_function property.

◆ upd_moment_arm_functions()

Function& OpenSim::FunctionBasedPath::upd_moment_arm_functions ( int i )

inline

Get a writable reference to the i-th element of the moment_arm_functions property.

OpenSim Property, Socket, Output, Input Documentation

◆ coordinate_paths

std::string OpenSim::FunctionBasedPath::coordinate_paths

"The list of paths to the model coordinates that are used as " "arguments to the length, lengthening speed, and moment arm " "functions. You must provide a least one coordinate path, and " "the order of the paths must match the order of the arguments " "passed to `length_function` (and `moment_arm_functions` and " "`lengthening_speed_function`, if provided)."

This property appears in XML files under the tag <coordinate_paths>. This property holds a list of objects, and was generated with the OpenSim_DECLARE_LIST_PROPERTY macro; see Property to learn about the property system.

See also: get_coordinate_paths(), upd_coordinate_paths(), set_coordinate_paths(), append_coordinate_paths()

◆ length_function

Function OpenSim::FunctionBasedPath::length_function

"(Required) The OpenSim::Function object that computes the length " "of the path as a function of the coordinate values. The function " "arguments must match the order in `coordinate_paths`."

This property appears in XML files under the tag <length_function>. This property was generated with the OpenSim_DECLARE_OPTIONAL_PROPERTY macro; see Property to learn about the property system.

See also: get_length_function(), upd_length_function(), set_length_function()

◆ lengthening_speed_function

Function OpenSim::FunctionBasedPath::lengthening_speed_function

"(Optional) The OpenSim::Function object that computes the speed " "of the path as a function of the coordinate values and speeds. " "The function arguments must be the coordinate values followed by " "coordinate speeds, both matching the order in " "`coordinate_paths`."

This property appears in XML files under the tag <lengthening_speed_function>. This property was generated with the OpenSim_DECLARE_OPTIONAL_PROPERTY macro; see Property to learn about the property system.

See also: get_lengthening_speed_function(), upd_lengthening_speed_function(), set_lengthening_speed_function()

◆ moment_arm_functions

Function OpenSim::FunctionBasedPath::moment_arm_functions

"(Optional) The list of OpenSim::Function objects that compute the " "moment arms of the path as a function of the coordinate values. " "The function arguments must match the order in " "`coordinate_paths`."

This property appears in XML files under the tag <moment_arm_functions>. This property holds a list of objects, and was generated with the OpenSim_DECLARE_LIST_PROPERTY macro; see Property to learn about the property system.

See also: get_moment_arm_functions(), upd_moment_arm_functions(), set_moment_arm_functions(), append_moment_arm_functions()

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

OpenSim/Simulation/Model/FunctionBasedPath.h

OpenSim Properties, Sockets, Outputs, Inputs

Public Member Functions

Public Types

Auto-generated functions

Additional Inherited Members

Detailed Description

References

Member Typedef Documentation

◆ Self

◆ Super

Constructor & Destructor Documentation

◆ FunctionBasedPath()

Member Function Documentation

◆ addInEquivalentForces()

◆ append_coordinate_paths()

◆ append_moment_arm_functions()

◆ appendCoordinatePath()

◆ appendMomentArmFunction()

◆ assign()

◆ clone()

◆ computeMomentArm()

◆ get_coordinate_paths()

◆ get_length_function()

◆ get_lengthening_speed_function()

◆ get_moment_arm_functions()

◆ getClassName()

◆ getConcreteClassName()

◆ getCoordinatePaths()

◆ getLength()

◆ getLengtheningSpeed()

◆ getLengtheningSpeedFunction()

◆ getLengthFunction()

◆ getMomentArmFunction()

◆ getMomentArms()

◆ isVisualPath()

◆ safeDownCast()

◆ set_coordinate_paths()

◆ set_length_function()

◆ set_lengthening_speed_function()

◆ set_moment_arm_functions()

◆ setCoordinatePaths()

◆ setLengtheningSpeedFunction()

◆ setLengthFunction()

◆ setMomentArmFunctions()

◆ upd_coordinate_paths()

◆ upd_length_function()

◆ upd_lengthening_speed_function()

◆ upd_moment_arm_functions()

OpenSim Property, Socket, Output, Input Documentation

◆ coordinate_paths

◆ length_function

◆ lengthening_speed_function

◆ moment_arm_functions