OpenSim::PathSpring Class Reference

A class implementing a PathSpring. More...

Inheritance diagram for OpenSim::PathSpring:

Public Member Functions
	PathSpring ()
	Default constructor. More...
	PathSpring (const std::string &name, double restLength, double stiffness, double dissipation)
	Convenience constructor with PathSpring parameters. More...
double	getRestingLength () const
	get/set the resting length More...
void	setRestingLength (double restingLength)
double	getStiffness () const
	get/set the stiffness More...
void	setStiffness (double stiffness)
double	getDissipation () const
	get/set the dissipation factor More...
void	setDissipation (double dissipation)
const GeometryPath &	getGeometryPath () const
	Access the GeometryPath to update connection points and specify wrap objects the path can interact with. More...
GeometryPath &	updGeometryPath ()
double	getLength (const SimTK::State &s) const
	get the length of the PathSpring. More...
double	getStretch (const SimTK::State &s) const
	get the stretch in the PathSpring. More...
double	getLengtheningSpeed (const SimTK::State &s) const
	get the length of the PathSpring. More...
double	getTension (const SimTK::State &s) const
	get the tension generated by the PathSpring. More...
double	computeMomentArm (const SimTK::State &s, Coordinate &aCoord) const
	compute the moment-arm of the PathSpring about a coordinat of interest. More...
void	preScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Scale the PathSpring. More...
void	scale (const SimTK::State &s, const ScaleSet &scaleSet)
void	postScale (const SimTK::State &s, const ScaleSet &scaleSet)
Property declarations
These are the serializable properties associated with this class.
	OpenSim_DECLARE_PROPERTY (resting_length, double,"The resting length (m) of the PathSpring")
	OpenSim_DECLARE_PROPERTY (stiffness, double,"The linear stiffness (N/m) of the PathSpring")
	OpenSim_DECLARE_PROPERTY (dissipation, double,"The dissipation factor (s/m) of the PathSpring")
	OpenSim_DECLARE_UNNAMED_PROPERTY (GeometryPath,"The GeometryPath defines the set of points and wrapping surface""interactions that form the path of action of the PathSpring")
Public Member Functions inherited from OpenSim::Force
	Force (const Force &aForce)
	Implements a copy constructor just so it can invalidate the SimTK::Force index after copying. More...
Force &	operator= (const Force &aForce)
	Implements a copy assignment operator just so it can invalidate the SimTK::Force index after the assignment. More...
bool	isDisabled (const SimTK::State &s) const
	Return if the Force is disabled or not. More...
void	setDisabled (SimTK::State &s, bool disabled) const
	Set the Force as disabled (true) or not (false). More...
virtual bool	hasGeometryPath () const
	Return a flag indicating whether the Force is applied along a Path. More...
	OpenSim_DECLARE_PROPERTY (isDisabled, bool,"Flag indicating whether the force is disabled or not. Disabled means"" that the force is not active in subsequent dynamics realizations.")
	A Force element is active (enabled) by default. More...
Public Member Functions inherited from OpenSim::ModelComponent
	ModelComponent ()
	Default constructor. More...
	ModelComponent (const std::string &aFileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
	Construct ModelComponent from an XML file. More...
	ModelComponent (SimTK::Xml::Element &aNode)
	Construct ModelComponent from a specific node in an XML document. More...
	ModelComponent (const ModelComponent &source)
	Construct ModelComponent with its contents copied from another ModelComponent; this is a deep copy so nothing is shared with the source after the copy. More...
virtual	~ModelComponent ()
	Destructor is virtual to allow concrete model component cleanup. More...
ModelComponent &	operator= (const ModelComponent &aModelComponent)
	Assignment operator to copy contents of an existing component. 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...
virtual int	getNumStateVariables () const
	Get the number of "Continuous" state variables maintained by the ModelComponent and its specified subcomponents. More...
virtual Array< std::string >	getStateVariableNames () const
	Get the names of "continuous" state variables maintained by the ModelComponent and its subcomponents. More...
virtual SimTK::SystemYIndex	getStateVariableSystemIndex (const std::string &stateVariableName) const
	Get the System Index of a state variable allocated by this ModelComponent. More...
int	getModelingOption (const SimTK::State &state, const std::string &name) const
	Get a ModelingOption flag for this ModelComponent by name. More...
void	setModelingOption (SimTK::State &state, const std::string &name, int flag) const
	Set the value of a ModelingOption flag for this ModelComponent. More...
double	getStateVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a state variable allocated by this ModelComponent. More...
void	setStateVariable (SimTK::State &state, const std::string &name, double value) const
	Set the value of a state variable allocated by this ModelComponent by name. More...
double	getDiscreteVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a discrete variable allocated by this ModelComponent by name. More...
void	setDiscreteVariable (SimTK::State &state, const std::string &name, double value) const
	Set the value of a discrete variable allocated by this ModelComponent by name. More...
template<typename T >
const T &	getCacheVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a cache variable allocated by this ModelComponent by name. More...
template<typename T >
const T &	getCacheVariable (const SimTK::State &state, SimTK::CacheEntryIndex ceIndex) const
template<typename T >
T &	updCacheVariable (const SimTK::State &state, const std::string &name) const
	Obtain a writable cache variable value allocated by this ModelComponent by name. More...
template<typename T >
T &	updCacheVariable (const SimTK::State &state, SimTK::CacheEntryIndex ceIndex) const
void	markCacheVariableValid (const SimTK::State &state, const std::string &name) const
	After updating a cache variable value allocated by this ModelComponent, you can mark its value as valid, which will not change until the realization stage falls below the minimum set at the time the cache variable was created. More...
void	markCacheVariableValid (const SimTK::State &state, SimTK::CacheEntryIndex ceIndex) const
void	markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const
	Mark a cache variable value allocated by this ModelComponent as invalid. More...
void	markCacheVariableInvalid (const SimTK::State &state, SimTK::CacheEntryIndex ceIndex) const
bool	isCacheVariableValid (const SimTK::State &state, const std::string &name) const
	Enables the to monitor the validity of the cache variable value using the returned flag. More...
bool	isCacheVariableValid (const SimTK::State &state, SimTK::CacheEntryIndex ceIndex) const
template<typename T >
void	setCacheVariable (const SimTK::State &state, const std::string &name, const T &value) const
	Set cache variable value allocated by this ModelComponent by name. More...
template<typename T >
void	setCacheVariable (const SimTK::State &state, SimTK::CacheEntryIndex ceIndex, const T &value) const
Public Member Functions inherited from OpenSim::Object
virtual	~Object ()
	Virtual destructor for cleanup. More...
virtual Object *	clone () const =0
	Create a new heap-allocated copy of the concrete object to which this Object refers. More...
virtual const std::string &	getConcreteClassName () const =0
	Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...
virtual VisibleObject *	updDisplayer ()
	get Non const pointer to VisibleObject 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, call this method in your constructor if needed. 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...
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...
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...
virtual void	updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
	Use this method to deserialize an object from a SimTK::Xml::Element. More...
virtual void	updateXMLNode (SimTK::Xml::Element &parent)
	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...
void	setAllPropertiesUseDefault (bool aUseDefault)
bool	print (const std::string &fileName)
	Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...
std::string	dump (bool dumpName=false)
	dump the XML representation of this Object into an std::string and return it. More...
void	clearObjectIsUpToDateWithProperties ()
	For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag. 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

Protected Member Functions
void	computeForce (const SimTK::State &s, SimTK::Vector_< SimTK::SpatialVec > &bodyForces, SimTK::Vector &generalizedForces) const override
	Implementation of Force component virtual method. More...
void	connectToModel (Model &aModel) override
	Implement ModelComponent interface. More...
void	addToSystem (SimTK::MultibodySystem &system) const override
	Default is to create a ForceAdapter which is a SimTK::Force::Custom as the underlying computational component. More...
void	initStateFromProperties (SimTK::State &s) const override
	Subclass should override; be sure to invoke Force::initStateFromProperties() at the beginning of the overriding method. More...
OpenSim::Array< std::string >	getRecordLabels () const
	Methods to query a Force for the value actually applied during simulation The names of the quantities (column labels) is returned by this first function getRecordLabels() More...
OpenSim::Array< double >	getRecordValues (const SimTK::State &state) const
	Given SimTK::State object extract all the values necessary to report forces, application location frame, etc. More...
const VisibleObject *	getDisplayer () const override
	Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects. More...
void	updateDisplayer (const SimTK::State &s) const override
	In case the ModelComponent has a visual representation (VisualObject), override this method to update it. More...
Protected Member Functions inherited from OpenSim::Force
	Force ()
	Default constructor sets up Force-level properties; can only be called from a derived class constructor. More...
	Force (SimTK::Xml::Element &node)
	Deserialization from XML, necessary so that derived classes can (de)serialize. More...
virtual void	setPropertiesFromState (const SimTK::State &state) override
	Subclass should override; be sure to invoke Force::setPropertiesFromState() at the beginning of the overriding method. More...
virtual double	computePotentialEnergy (const SimTK::State &state) const
	Subclasses may optionally override this method to compute a contribution to the potential energy of the system. More...
void	applyForceToPoint (const SimTK::State &state, const OpenSim::Body &body, const SimTK::Vec3 &point, const SimTK::Vec3 &force, SimTK::Vector_< SimTK::SpatialVec > &bodyForces) const
	Apply a force at a particular point (a "station") on a given body. More...
void	applyTorque (const SimTK::State &state, const OpenSim::Body &body, const SimTK::Vec3 &torque, SimTK::Vector_< SimTK::SpatialVec > &bodyForces) const
	Apply a torque to a particular body. More...
void	applyGeneralizedForce (const SimTK::State &state, const Coordinate &coord, double force, SimTK::Vector &generalizedForces) const
	Apply a generalized force. More...
Protected Member Functions inherited from OpenSim::ModelComponent
virtual SimTK::Vector	computeStateVariableDerivatives (const SimTK::State &s) const
	If a model component has allocated any continuous state variables using the addStateVariable() method, then computeStateVariableDerivatives() must be implemented to provide time derivatives for those states. 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 ModelComponent at the specified state. More...
virtual void	realizeTopology (SimTK::State &state) const
	Obtain state resources that are needed unconditionally, and perform computations that depend only on the system topology. More...
virtual void	realizeModel (SimTK::State &state) const
	Obtain state resources that may be needed, depending on modeling options, and perform computations that depend only on topology and selected modeling options. More...
virtual void	realizeInstance (const SimTK::State &state) const
	Perform computations that depend only on instance variables, like lengths and masses. More...
virtual void	realizeTime (const SimTK::State &state) const
	Perform computations that depend only on time and earlier stages. More...
virtual void	realizePosition (const SimTK::State &state) const
	Perform computations that depend only on position-level state variables and computations performed in earlier stages (including time). More...
virtual void	realizeVelocity (const SimTK::State &state) const
	Perform computations that depend only on velocity-level state variables and computations performed in earlier stages (including position, and time). More...
virtual void	realizeDynamics (const SimTK::State &state) const
	Perform computations (typically forces) that may depend on dynamics-stage state variables, and on computations performed in earlier stages (including velocity, position, and time), but not on other forces, accelerations, constraint multipliers, or reaction forces. More...
virtual void	realizeAcceleration (const SimTK::State &state) const
	Perform computations that may depend on applied forces. More...
virtual void	realizeReport (const SimTK::State &state) const
	Perform computations that may depend on anything but are only used for reporting and cannot affect subsequent simulation behavior. More...
void	includeAsSubComponent (ModelComponent *aComponent)
	Include another ModelComponent as a Subcomponent of this ModelComponent. More...
void	addModelingOption (const std::string &optionName, int maxFlagValue) const
	Add a modeling option (integer flag stored in the State) for use by this ModelComponent. More...
void	addStateVariable (const std::string &stateVariableName, SimTK::Stage invalidatesStage=SimTK::Stage::Dynamics) const
	Add a continuous system state variable belonging to this ModelComponent, and assign a name by which to refer to it. More...
void	addDiscreteVariable (const std::string &discreteVariableName, SimTK::Stage invalidatesStage) const
	Add a system discrete variable belonging to this ModelComponent, give it a name by which it can be referenced, and declare the lowest Stage that should be invalidated if this variable's value is changed. More...
template<class T >
void	addCacheVariable (const std::string &cacheVariableName, const T &variablePrototype, SimTK::Stage dependsOnStage) const
	Add a state cache entry belonging to this ModelComponent to hold calculated values that must be automatically invalidated when certain state values change. More...
const int	getStateIndex (const std::string &name) const
	Get the index of a ModelComponent's continuous state variable in the Subsystem for allocations. More...
const SimTK::DiscreteVariableIndex	getDiscreteVariableIndex (const std::string &name) const
	Get the index of a ModelComponent's discrete variable in the Subsystem for allocations. More...
const SimTK::CacheEntryIndex	getCacheVariableIndex (const std::string &name) const
	Get the index of a ModelComponent's cache variable in the Subsystem for allocations. 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) SWIG_DECLARE_EXCEPTION
	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...
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...

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 void	PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName)
	Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...
static void	PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName)
	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 debug level to get verbose output. More...
static int	getDebugLevel ()
	Get 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 Attributes inherited from OpenSim::Force
SimTK::ForceIndex	_index
	ID for the force in Simbody. More...
Protected Attributes inherited from OpenSim::ModelComponent
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...
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 class implementing a PathSpring.

The path of the PathSpring is determined by a GeometryPath object. A PathSpring is a massless Force element which applies tension along a path connected to bodies and can wrap over surfaces. The tension is proportional to its stretch beyond its resting length and the amount of dissipation scales with amount of stretch, such that tension = (K*s)*(1+D*ldot) where stretch, s = l-lo for l > lo, and 0 otherwise. l is the path length of the spring and lo is its rest length. K is the linear stiffness and D is the dissipation factor. When l < lo the spring applies no tension to the bodies and considered to be slack.

Author

Ajay Seth

Constructor & Destructor Documentation

OpenSim::PathSpring::PathSpring

(

)

Default constructor.

OpenSim::PathSpring::PathSpring	(	const std::string &	name,
		double	restLength,
		double	stiffness,
		double	dissipation
	)

Convenience constructor with PathSpring parameters.

Parameters

name	name of this PathSpring Object
restLength	the spring's resting length
stiffness	the spring stiffness
dissipation	the dissipation factor

Member Function Documentation

void OpenSim::PathSpring::addToSystem ( SimTK::MultibodySystem &  system ) const

overrideprotectedvirtual

Default is to create a ForceAdapter which is a SimTK::Force::Custom as the underlying computational component.

Subclasses override to employ other SimTK::Forces; be sure to invoke Force::addToSystem() at the beginning of the overriding method.

Reimplemented from OpenSim::Force.

void OpenSim::PathSpring::computeForce ( const SimTK::State &  s, SimTK::Vector_< SimTK::SpatialVec > &  bodyForces, SimTK::Vector &  generalizedForces  ) const

overrideprotectedvirtual

Implementation of Force component virtual method.

Reimplemented from OpenSim::Force.

double OpenSim::PathSpring::computeMomentArm	(	const SimTK::State &	s,
		Coordinate &	aCoord
	)		const

compute the moment-arm of the PathSpring about a coordinat of interest.

void OpenSim::PathSpring::connectToModel ( Model &  aModel )

overrideprotectedvirtual

Implement ModelComponent interface.

Reimplemented from OpenSim::ModelComponent.

const VisibleObject* OpenSim::PathSpring::getDisplayer ( ) const

overrideprotectedvirtual

Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.

Get const pointer to VisibleObject that contains geometry

Reimplemented from OpenSim::Object.

double OpenSim::PathSpring::getDissipation ( ) const

inline

get/set the dissipation factor

const GeometryPath& OpenSim::PathSpring::getGeometryPath ( ) const

inline

Access the GeometryPath to update connection points and specify wrap objects the path can interact with.

double OpenSim::PathSpring::getLength

(

const SimTK::State &

s

)

const

get the length of the PathSpring.

Accessible at Stage::Position

double OpenSim::PathSpring::getLengtheningSpeed

(

const SimTK::State &

s

)

const

get the length of the PathSpring.

Accessible at Stage::Velocity

OpenSim::Array<std::string> OpenSim::PathSpring::getRecordLabels ( ) const

inlineprotectedvirtual

Methods to query a Force for the value actually applied during simulation The names of the quantities (column labels) is returned by this first function getRecordLabels()

Reimplemented from OpenSim::Force.

References OpenSim::Array< T >::append().

OpenSim::Array<double> OpenSim::PathSpring::getRecordValues ( const SimTK::State &  state ) const

inlineprotectedvirtual

Given SimTK::State object extract all the values necessary to report forces, application location frame, etc.

used in conjunction with getRecordLabels and should return same size Array

Reimplemented from OpenSim::Force.

References OpenSim::Array< T >::append().

double OpenSim::PathSpring::getRestingLength ( ) const

inline

get/set the resting length

double OpenSim::PathSpring::getStiffness ( ) const

inline

get/set the stiffness

double OpenSim::PathSpring::getStretch

(

const SimTK::State &

s

)

const

get the stretch in the PathSpring.

The value of the stretch can only be obtained after the system as be realized to Stage::Position

double OpenSim::PathSpring::getTension

(

const SimTK::State &

s

)

const

get the tension generated by the PathSpring.

The value of the tension can only be obtained after the system as be realized to Stage::Dynamics

void OpenSim::PathSpring::initStateFromProperties ( SimTK::State &  state ) const

overrideprotectedvirtual

Subclass should override; be sure to invoke Force::initStateFromProperties() at the beginning of the overriding method.

Reimplemented from OpenSim::Force.

OpenSim::PathSpring::OpenSim_DECLARE_PROPERTY	(	resting_length	,
		double	,
		"The resting length (m) of the PathSpring"
	)

OpenSim::PathSpring::OpenSim_DECLARE_PROPERTY	(	stiffness	,
		double	,
		"The linear stiffness (N/m) of the PathSpring"
	)

OpenSim::PathSpring::OpenSim_DECLARE_PROPERTY	(	dissipation	,
		double	,
		"The dissipation factor (s/m) of the PathSpring"
	)

OpenSim::PathSpring::OpenSim_DECLARE_UNNAMED_PROPERTY	(	GeometryPath	,
		"The GeometryPath defines the set of points and wrapping surface""interactions that form the path of action of the PathSpring"
	)

void OpenSim::PathSpring::postScale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

void OpenSim::PathSpring::preScale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

Scale the PathSpring.

Parameters

s	the (SimTK::) State of system that defines the current pose
scaleSet	XYZ scale factors for all the bodies in the model

void OpenSim::PathSpring::scale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

void OpenSim::PathSpring::setDissipation

(

double

dissipation

)

void OpenSim::PathSpring::setRestingLength

(

double

restingLength

)

void OpenSim::PathSpring::setStiffness

(

double

stiffness

)

void OpenSim::PathSpring::updateDisplayer ( const SimTK::State &  s ) const

overrideprotectedvirtual

In case the ModelComponent has a visual representation (VisualObject), override this method to update it.

This is typically done by recomputing anchor points and positions based on transforms obtained from current state.

Reimplemented from OpenSim::ModelComponent.

GeometryPath& OpenSim::PathSpring::updGeometryPath ( )

inline

---

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

• OpenSim/Simulation/Model/PathSpring.h