Public Member Functions |
| | CoordinateLimitForce () |
| | Default constructor.
|
| | CoordinateLimitForce (const std::string &coordName, double q_upper, double K_upper, double q_lower, double K_lower, double damping, double dq, bool computeDissipationEnergy=false) |
| | Convenience constructor.
|
| | ~CoordinateLimitForce () |
| | Destructor.
|
| void | setUpperStiffness (double aUpperStiffness) |
| | Stiffness of the passive limit force when coordinate exceeds upper limit.
|
| double | getUpperStiffness () const |
| void | setUpperLimit (double aUpperLimit) |
| | Upper limit of the coordinate range of motion (rotations in degrees).
|
| double | getUpperLimit () const |
| void | setLowerStiffness (double aLowerStiffness) |
| | Stiffness of the passive limit force when coordinate exceeds lower limit.
|
| double | getLowerStiffness () const |
| void | setLowerLimit (double aLowerLimit) |
| | Lower limit of the coordinate range of motion (rotations in degrees).
|
| double | getLowerLimit () const |
| void | setDamping (double aDamping) |
| | Damping factor on the coordinate's speed applied only when limit is exceeded.
|
| double | getDamping () const |
| void | setTransition (double aTransition) |
| | Transition region width with lengths is m and angles in degrees).
|
| double | getTransition () const |
| void | setComputeDissipationEnergy (bool flag) |
| | Option to compute the dissipation energy due to damping in the CoordinateLimitForce.
|
| bool | isComputingDissipationEnergy () const |
| double | getPowerDissipation (const SimTK::State &s) const |
| | Obtain the rate at which energy is being dissipated by this CoordinateLimit, that is, the power being lost.
|
| double | getDissipatedEnergy (const SimTK::State &s) const |
| | Obtain energy dissipated by this CoordinateLimitForce over time in units of energy in J.
|
| double | calcLimitForce (const SimTK::State &s) const |
| | Force calculation operator.
|
| double | computePotentialEnergy (const SimTK::State &s) const |
| | Contribute this Force component's potential energy to the accounting of the total system energy.
|
| Array< std::string > | getRecordLabels () const |
| | Methods to query a Force for the value actually applied during simulation The names of quantities (column labels) are returned by getRecordLabels()
|
| Array< double > | getRecordValues (const SimTK::State &state) const |
| | Given SimTK::State object extract all the values necessary to report forces, application location frame, etc.
|
|
These are the serializable properties associated with this class.
|
| | OpenSim_DECLARE_PROPERTY (coordinate, std::string,"Coordinate (name) to be limited.") |
| | OpenSim_DECLARE_PROPERTY (upper_stiffness, double,"Stiffness of the passive limit force when coordinate exceeds upper ""limit. Note, rotational stiffness expected in N*m/degree.") |
| | OpenSim_DECLARE_PROPERTY (upper_limit, double,"The upper limit of the coordinate range of motion (rotations in ""degrees).") |
| | OpenSim_DECLARE_PROPERTY (lower_stiffness, double,"Stiffness of the passive limit force when coordinate exceeds lower ""limit. Note, rotational stiffness expected in N*m/degree.") |
| | OpenSim_DECLARE_PROPERTY (lower_limit, double,"The lower limit of the coordinate range of motion (rotations in ""degrees).") |
| | OpenSim_DECLARE_PROPERTY (damping, double,"Damping factor on the coordinate's speed applied only when limit ""is exceeded. For translational has units N/(m/s) and rotational has ""Nm/(degree/s)") |
| | OpenSim_DECLARE_PROPERTY (transition, double,"Transition region width in the units of the coordinate (rotations ""in degrees). Dictates the transition from zero to constant stiffness ""as coordinate exceeds its limit.") |
| | OpenSim_DECLARE_PROPERTY (compute_dissipation_energy, bool,"Option to compute the dissipation energy due to damping in the ""CoordinateLimitForce. If true the dissipation power is automatically ""integrated to provide energy. Default is false.") |
| | 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.
|
| | 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.
|
| 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 const VisibleObject * | getDisplayer () const |
| | Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
|
| 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 Member Functions |
| void | connectToModel (Model &aModel) override |
| | Setup this CoordinateLimitForce as part of the model.
|
| void | addToSystem (SimTK::MultibodySystem &system) const override |
| | Create the underlying Force that is part of the multibodysystem.
|
| void | computeForce (const SimTK::State &s, SimTK::Vector_< SimTK::SpatialVec > &bodyForces, SimTK::Vector &mobilityForces) const override |
| | Subclasses must implement this method to compute the forces that should be applied to bodies and generalized speeds.
|
| | 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.
|
| 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.
|
| 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.
|
| 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.
|
| virtual void | realizeTopology (SimTK::State &state) const |
| | Obtain state resources that are needed unconditionally, and perform computations that depend only on the system topology.
|
| 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.
|
| virtual void | realizeInstance (const SimTK::State &state) const |
| | Perform computations that depend only on instance variables, like lengths and masses.
|
| virtual void | realizeTime (const SimTK::State &state) const |
| | Perform computations that depend only on time and earlier stages.
|
| 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).
|
| 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).
|
| 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.
|
| virtual void | realizeAcceleration (const SimTK::State &state) const |
| | Perform computations that may depend on applied forces.
|
| 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.
|
| void | includeAsSubComponent (ModelComponent *aComponent) |
| | Include another ModelComponent as a Subcomponent of this ModelComponent.
|
| void | addModelingOption (const std::string &optionName, int maxFlagValue) const |
| | Add a modeling option (integer flag stored in the State) for use by this ModelComponent.
|
| 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.
|
| 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.
|
| 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.
|
| const int | getStateIndex (const std::string &name) const |
| | Get the index of a ModelComponent's continuous state variable in the Subsystem for allocations.
|
| const SimTK::DiscreteVariableIndex | getDiscreteVariableIndex (const std::string &name) const |
| | Get the index of a ModelComponent's discrete variable in the Subsystem for allocations.
|
| const SimTK::CacheEntryIndex | getCacheVariableIndex (const std::string &name) const |
| | Get the index of a ModelComponent's cache variable in the Subsystem for allocations.
|
| | Object () |
| | The default constructor is only for use by constructors of derived types.
|
| | 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.
|
| | Object (const Object &source) |
| | Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly.
|
| | Object (SimTK::Xml::Element &aElement) |
| | Construct the base class portion of an Object from a given Xml element that describes this Object.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| PropertyIndex | getPropertyIndex (const std::string &name) const |
| | Look up a property by name and return its PropertyIndex if it is found.
|
| 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.
|
| 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.
|
| void | setDocument (XMLDocument *doc) |
| | Unconditionally set the XMLDocument associated with this object.
|
| const XMLDocument * | getDocument () const |
| | Get a const pointer to the document (if any) associated with this object.
|
| XMLDocument * | updDocument () |
| | Get a writable pointer to the document (if any) associated with this object.
|
Additional Inherited Members |
| 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 const std::string | DEFAULT_NAME |
| | Name used for default objects when they are serialized.
|
| SimTK::ForceIndex | _index |
| | ID for the force in Simbody.
|
| #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.
|
Public Member Functions inherited from OpenSim::Force
1.8.1.2 
