#include <PointToPointSpring.h>

Inheritance diagram for OpenSim::PointToPointSpring:

Public Member Functions
	PointToPointSpring ()
	Default constructor.
	PointToPointSpring (std::string body1Name, SimTK::Vec3 point1, std::string body2Name, SimTK::Vec3 point2, double stiffness, double restlength)
	Convenience constructor for API users.
virtual VisibleObject *	getDisplayer () const
	Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
virtual void	updateDisplayer (const SimTK::State &s)
virtual void	updateGeometry (const SimTK::State &s)
void	setBody1Name (const std::string &body1Name)
	Spring end point bodies.
void	setBody2Name (const std::string &body2Name)
const std::string &	getBody1Name () const
const std::string &	getBody2Name () const
void	setPoint1 (SimTK::Vec3 aPosition)
	Spring end points.
const SimTK::Vec3 &	getPoint1 () const
void	setPoint2 (SimTK::Vec3 aPosition)
const SimTK::Vec3 &	getPoint2 () const
void	setStiffness (double stiffness)
	Spring stiffness.
double	getStiffness () const
void	setRestlength (double restLength)
	Spring resting length.
double	getRestlength () const
void	connectToModel (Model &model) override
	Perform any necessary initializations required to connect the component into the Model, and check for error conditions.
void	addToSystem (SimTK::MultibodySystem &system) const override
	Default is to create a ForceAdapter which is a SimTK::Force::Custom as the underlying computational component.
virtual OpenSim::Array < std::string >	getRecordLabels () const
	Provide name(s) of the quantities (column labels) of the force value(s) to be reported.
virtual OpenSim::Array< double >	getRecordValues (const SimTK::State &state) const
	Provide the value(s) to be reported that correspond to the labels.
Property declarations
These are the serializable properties associated with this class.
	OpenSim_DECLARE_OPTIONAL_PROPERTY (body1, std::string,"Name of Body to which 1 end of the spring is attached.")
	OpenSim_DECLARE_OPTIONAL_PROPERTY (body2, std::string,"Name of Body to which the 2nd end of the spring is attached.")
	OpenSim_DECLARE_PROPERTY (point1, SimTK::Vec3,"Force application point on body1.")
	OpenSim_DECLARE_PROPERTY (point2, SimTK::Vec3,"Force application point on body2.")
	OpenSim_DECLARE_PROPERTY (stiffness, double,"Spring stiffness (N/m).")
	OpenSim_DECLARE_PROPERTY (rest_length, double,"Spring resting length.")
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.
Force &	operator= (const Force &aForce)
	Implements a copy assignment operator just so it can invalidate the SimTK::Force index after the assignment.
bool	isDisabled (const SimTK::State &s) const
	Return if the Force is disabled or not.
void	setDisabled (SimTK::State &s, bool disabled)
	Set the Force as disabled (true) or not (false).
virtual bool	hasGeometryPath () const
	Return a flag indicating whether the Force is applied along a Path.
	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.
Public Member Functions inherited from OpenSim::ModelComponent
	ModelComponent ()
	Default constructor.
	ModelComponent (const std::string &aFileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
	Construct ModelComponent from an XML file.
	ModelComponent (SimTK::Xml::Element &aNode)
	Construct ModelComponent from a specific node in an XML document.
	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.
virtual	~ModelComponent ()
	Destructor is virtual to allow concrete model component cleanup.
ModelComponent &	operator= (const ModelComponent &aModelComponent)
	Assignment operator to copy contents of an existing component.
const Model &	getModel () const
	Get a const reference to the Model this component is part of.
Model &	updModel ()
	Get a modifiable reference to the Model this component is part of.
virtual void	updateDisplayer (const SimTK::State &s) const
	In case the ModelComponent has a visual representation (VisualObject), override this method to update it.
virtual int	getNumStateVariables () const
	Get the number of "Continuous" state variables maintained by the ModelComponent and its specified subcomponents.
virtual Array< std::string >	getStateVariableNames () const
	Get the names of "continuous" state variables maintained by the ModelComponent and its subcomponents.
virtual SimTK::SystemYIndex	getStateVariableSystemIndex (const std::string &stateVariableName) const
	Get the System Index of a state variable allocated by this ModelComponent.
int	getModelingOption (const SimTK::State &state, const std::string &name) const
	Get a ModelingOption flag for this ModelComponent by name.
void	setModelingOption (SimTK::State &state, const std::string &name, int flag) const
	Set the value of a ModelingOption flag for this ModelComponent.
double	getStateVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a state variable allocated by this ModelComponent.
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.
double	getDiscreteVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a discrete variable allocated by this ModelComponent by name.
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.
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.
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.
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.
void	markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const
	Mark a cache variable value allocated by this ModelComponent as invalid.
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.
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.
Public Member Functions inherited from OpenSim::Object
virtual	~Object ()
	Virtual destructor for cleanup.
virtual Object *	clone () const =0
	Create a new heap-allocated copy of the concrete object to which this Object refers.
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.
virtual VisibleObject *	updDisplayer ()
	get Non const pointer to VisibleObject
bool	isEqualTo (const Object &aObject) const
	Equality operator wrapper for use from languages not supporting operator overloading.
Object &	operator= (const Object &aObject)
	Copy assignment copies he base class fields, including the properties.
virtual bool	operator== (const Object &aObject) const
	Determine if two objects are equal.
virtual bool	operator< (const Object &aObject) const
	Provide an ordering for objects so they can be put in sorted containers.
void	setName (const std::string &name)
	Set the name of the Object.
const std::string &	getName () const
	Get the name of this Object.
void	setDescription (const std::string &description)
	Set description, a one-liner summary.
const std::string &	getDescription () const
	Get description, a one-liner summary.
const std::string &	getAuthors () const
	Get Authors of this Object.
void	setAuthors (const std::string &authors)
	Set Authors of this object, call this method in your constructor if needed.
const std::string &	getReferences () const
	Get references or publications to cite if using this object.
void	setReferences (const std::string &references)
	Set references or publications to cite if using this object.
int	getNumProperties () const
	Determine how many properties are stored with this Object.
const AbstractProperty &	getPropertyByIndex (int propertyIndex) const
	Get a const reference to a property by its index number, returned as an AbstractProperty.
AbstractProperty &	updPropertyByIndex (int propertyIndex)
	Get a writable reference to a property by its index number, returned as an AbstractProperty.
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.
const AbstractProperty &	getPropertyByName (const std::string &name) const
	Get a const reference to a property by its name, returned as an AbstractProperty.
AbstractProperty &	updPropertyByName (const std::string &name)
	Get a writable reference to a property by its name, returned as an AbstractProperty.
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.
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.
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.
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.
bool	isObjectUpToDateWithProperties () const
	Returns `true` if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called.
void	readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
	We're given an XML element from which we are to populate this Object.
virtual void	updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
	Use this method to deserialize an object from a SimTK::Xml::Element.
virtual void	updateXMLNode (SimTK::Xml::Element &parent)
	Serialize this object into the XML node that represents it.
bool	getInlined () const
	Inlined means an in-memory Object that is not associated with an XMLDocument.
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.
std::string	getDocumentFileName () const
	If there is a document associated with this object then return the file name maintained by the document.
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".
std::string	dump (bool dumpName=false)
	dump the XML representation of this Object into an std::string and return it.
void	clearObjectIsUpToDateWithProperties ()
	For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag.
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.
const std::string &	toString () const
	Wrapper to be used on Java side to display objects in tree; this returns just the object's name.
PropertySet &	getPropertySet ()
	OBSOLETE: Get a reference to the PropertySet maintained by the Object.
const PropertySet &	getPropertySet () const

Protected Attributes
VisibleObject	_displayer
	how to display the Spring
Protected Attributes inherited from OpenSim::Force
SimTK::ForceIndex	_index
	ID for the force in Simbody.
Protected Attributes inherited from OpenSim::ModelComponent
Model *	_model
	The model this component belongs to.
Protected Attributes inherited from OpenSim::Object
PropertySet	_propertySet
	OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes.

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.
static void	renameType (const std::string &oldTypeName, const std::string &newTypeName)
	Support versioning by associating the current Object type with an old name.
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.
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*.
static Object *	newInstanceOfType (const std::string &concreteClassName)
	Create a new instance of the concrete Object type whose class name is given as concreteClassName.
static void	getRegisteredTypenames (Array< std::string > &typeNames)
	Retrieve all the typenames registered so far.
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.
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.
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.
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.
static const std::string &	getClassName ()
	Return the name of this class as a string; i.e., "Object".
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.
static bool	getSerializeAllDefaults ()
	Report the value of the "serialize all defaults" flag.
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.
static void	setDebugLevel (int newLevel)
	Set the debug level to get verbose output.
static int	getDebugLevel ()
	Get current setting of debug level.
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.
static void	RegisterType (const Object &defaultObject)
	OBSOLETE alternate name for registerType().
static void	RenameType (const std::string &oldName, const std::string &newName)
	OBSOLETE alternate name for renameType().
Static Public Attributes inherited from OpenSim::Object
static const std::string	DEFAULT_NAME
	Name used for default objects when they are serialized.
Protected Member Functions inherited from OpenSim::Force
	Force ()
	Default constructor sets up Force-level properties; can only be called from a derived class constructor.
	Force (SimTK::Xml::Element &node)
	Deserialization from XML, necessary so that derived classes can (de)serialize.
virtual void	initStateFromProperties (SimTK::State &state) const override
	Subclass should override; be sure to invoke Force::initStateFromProperties() at the beginning of the overriding method.
virtual void	setPropertiesFromState (const SimTK::State &state) override
	Subclass should override; be sure to invoke Force::setPropertiesFromState() at the beginning of the overriding method.
virtual void	computeForce (const SimTK::State &state, SimTK::Vector_< SimTK::SpatialVec > &bodyForces, SimTK::Vector &generalizedForces) const
	Subclasses must implement this method to compute the forces that should be applied to bodies and generalized speeds.
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.
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.
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.
void	applyGeneralizedForce (const SimTK::State &state, const Coordinate &coord, double force, SimTK::Vector &generalizedForces) const
	Apply a generalized force.
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.
#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.
#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>.
#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.

Constructor & Destructor Documentation

OpenSim::PointToPointSpring::PointToPointSpring ( )

Default constructor.

OpenSim::PointToPointSpring::PointToPointSpring	(	std::string	body1Name,
		SimTK::Vec3	point1,
		std::string	body2Name,
		SimTK::Vec3	point2,
		double	stiffness,
		double	restlength
	)

Convenience constructor for API users.

Parameters

body1Name	name of the first body to which the spring is attached
point1	location where spring is attached on body1
body2Name	name of the second body to which the spring is attached
point2	location where spring is attached on body2
stiffness	spring stiffness
restlength	the resting (zero force) length of the spring

Member Function Documentation

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

overridevirtual

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::PointToPointSpring::connectToModel ( Model & model )

overridevirtual

Perform any necessary initializations required to connect the component into the Model, and check for error conditions.

connectToModel() is invoked on all components to complete construction of a Model, prior to creating a Simbody System to represent it computationally. It may also be invoked at times just for its error-checking side effects.

If you override this method, be sure to invoke the base class method first, using code like this:

void MyComponent::connectToModel(Model& model) {
    Super::connectToModel(model); // invoke parent class method
    // ... your code goes here
}

Note that this method is expected to check for modeling errors and should throw an OpenSim::Exception if there is something wrong. For example, if your model component references another object by name, you should verify that it exists in the supplied Model, which is not guaranteed since components may be independently instantiated or constructed from XML files.

Parameters

[in,out] model The Model currently being constructed to which this ModelComponent should be connected.

Reimplemented from OpenSim::ModelComponent.

const std::string& OpenSim::PointToPointSpring::getBody1Name ( ) const

inline

const std::string& OpenSim::PointToPointSpring::getBody2Name ( ) const

inline

virtual VisibleObject* OpenSim::PointToPointSpring::getDisplayer ( ) const

virtual

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.

const SimTK::Vec3& OpenSim::PointToPointSpring::getPoint1 ( ) const

inline

const SimTK::Vec3& OpenSim::PointToPointSpring::getPoint2 ( ) const

inline

virtual OpenSim::Array<std::string> OpenSim::PointToPointSpring::getRecordLabels ( ) const

virtual

Provide name(s) of the quantities (column labels) of the force value(s) to be reported.

Reimplemented from OpenSim::Force.

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

virtual

Provide the value(s) to be reported that correspond to the labels.

Reimplemented from OpenSim::Force.

double OpenSim::PointToPointSpring::getRestlength ( ) const

inline

double OpenSim::PointToPointSpring::getStiffness ( ) const

inline

OpenSim::PointToPointSpring::OpenSim_DECLARE_OPTIONAL_PROPERTY	(	body1	,
		std::string	,
		"Name of Body to which 1 end of the spring is attached."
	)

OpenSim::PointToPointSpring::OpenSim_DECLARE_OPTIONAL_PROPERTY	(	body2	,
		std::string	,
		"Name of Body to which the 2nd end of the spring is attached."
	)

OpenSim::PointToPointSpring::OpenSim_DECLARE_PROPERTY	(	point1	,
		SimTK::Vec3	,
		"Force application point on body1."
	)

OpenSim::PointToPointSpring::OpenSim_DECLARE_PROPERTY	(	point2	,
		SimTK::Vec3	,
		"Force application point on body2."
	)

OpenSim::PointToPointSpring::OpenSim_DECLARE_PROPERTY	(	stiffness	,
		double	,
		"Spring stiffness (N/m)."
	)

OpenSim::PointToPointSpring::OpenSim_DECLARE_PROPERTY	(	rest_length	,
		double	,
		"Spring resting length."
	)

void OpenSim::PointToPointSpring::setBody1Name ( const std::string & body1Name )

inline

Spring end point bodies.

void OpenSim::PointToPointSpring::setBody2Name ( const std::string & body2Name )

inline

void OpenSim::PointToPointSpring::setPoint1 ( SimTK::Vec3 aPosition )

inline

Spring end points.

void OpenSim::PointToPointSpring::setPoint2 ( SimTK::Vec3 aPosition )

inline

void OpenSim::PointToPointSpring::setRestlength ( double restLength )

inline

Spring resting length.

Parameters

restLength

void OpenSim::PointToPointSpring::setStiffness ( double stiffness )

inline

Spring stiffness.

Parameters

stiffness

virtual void OpenSim::PointToPointSpring::updateDisplayer ( const SimTK::State & s )

virtual

virtual void OpenSim::PointToPointSpring::updateGeometry ( const SimTK::State & s )

virtual

Member Data Documentation

VisibleObject OpenSim::PointToPointSpring::_displayer

protected

how to display the Spring

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

E:/Projects/OpenSimTrunk/OpenSim/Simulation/Model/PointToPointSpring.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation