API  4.3
For MATLAB, Python, Java, and C++ users
OpenSim::PointActuator Class Reference

A class that implements a point actuator acting on the model. More...

+ Inheritance diagram for OpenSim::PointActuator:

OpenSim Properties, Sockets, Outputs, Inputs

Properties (optional)
std::string body
 "Name of Body to which this actuator is applied." More...
 
Properties (single-value)
SimTK::Vec3 point
 "Location of application point; in body frame unless " "point_is_global=true" More...
 
bool point_is_global
 "Interpret point in Ground frame if true; otherwise, body frame." More...
 
SimTK::Vec3 direction
 "Force application direction; in body frame unless " "force_is_global=true." More...
 
bool force_is_global
 "Interpret direction in Ground frame if true; otherwise, body frame." More...
 
double optimal_force
 "The maximum force produced by this actuator when fully activated." More...
 
- OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::ScalarActuator
double min_control
 "Minimum allowed value for control signal. Used primarily when solving " "for control values." More...
 
double max_control
 "Maximum allowed value for control signal. Used primarily when solving " "for control values." More...
 
double actuation
 Provides the value of getActuation() and is available at stage SimTK::Stage::Velocity . More...
 
double speed
 Provides the value of getSpeed() and is available at stage SimTK::Stage::Velocity . More...
 
- OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::Actuator
double power
 Provides the value of getPower() and is available at stage SimTK::Stage::Dynamics . More...
 
- OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::Force
bool appliesForce
 "Flag indicating whether the force is applied or not. If true the force" "is applied to the MultibodySystem otherwise the force is not applied." "NOTE: Prior to OpenSim 4.0, this behavior was controlled by the " "'isDisabled' property, where 'true' meant that force was not being " "applied. Thus, if 'isDisabled' is true, then 'appliesForce` is false." More...
 
double potential_energy
 Provides the value of computePotentialEnergy() and is available at stage SimTK::Stage::Velocity . 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

 PointActuator (const std::string &bodyName="")
 Default constructor or construct with body name given. More...
 
void setOptimalForce (double aOptimalForce)
 Set the 'optimal_force' property. More...
 
double getOptimalForce () const override
 Get the current value of the 'optimal_force' property. More...
 
Property-related functions
const std::string & get_body () const
 Get the value of the body property. More...
 
std::string & upd_body ()
 Get a writable reference to the body property. More...
 
void set_body (const std::string &value)
 Set the value of the body property. More...
 
const SimTK::Vec3 & get_point () const
 Get the value of the point property. More...
 
SimTK::Vec3 & upd_point ()
 Get a writable reference to the point property. More...
 
void set_point (const SimTK::Vec3 &value)
 Set the value of the point property. More...
 
const bool & get_point_is_global () const
 Get the value of the point_is_global property. More...
 
bool & upd_point_is_global ()
 Get a writable reference to the point_is_global property. More...
 
void set_point_is_global (const bool &value)
 Set the value of the point_is_global property. More...
 
const SimTK::Vec3 & get_direction () const
 Get the value of the direction property. More...
 
SimTK::Vec3 & upd_direction ()
 Get a writable reference to the direction property. More...
 
void set_direction (const SimTK::Vec3 &value)
 Set the value of the direction property. More...
 
const bool & get_force_is_global () const
 Get the value of the force_is_global property. More...
 
bool & upd_force_is_global ()
 Get a writable reference to the force_is_global property. More...
 
void set_force_is_global (const bool &value)
 Set the value of the force_is_global property. More...
 
const double & get_optimal_force () const
 Get the value of the optimal_force property. More...
 
double & upd_optimal_force ()
 Get a writable reference to the optimal_force property. More...
 
void set_optimal_force (const double &value)
 Set the value of the optimal_force property. More...
 
- Public Member Functions inherited from OpenSim::ScalarActuator
 ScalarActuator ()
 
virtual double getControl (const SimTK::State &s) const
 Convenience method to get control given scalar (double) valued control. More...
 
int numControls () const override
 
virtual void setActuation (const SimTK::State &s, double aActuation) const
 
virtual double getActuation (const SimTK::State &s) const
 
virtual void setSpeed (const SimTK::State &s, double aspeed) const
 
virtual double getSpeed (const SimTK::State &s) const
 
double getPower (const SimTK::State &s) const override
 
void setMinControl (const double &aMinControl)
 Methods to manage the bounds on ScalarActuator's control. More...
 
double getMinControl () const
 
void setMaxControl (const double &aMaxControl)
 
double getMaxControl () const
 
void overrideActuation (SimTK::State &s, bool flag) const
 Enable/disable a ScalarActuator's override actuation. More...
 
bool isActuationOverridden (const SimTK::State &s) const
 return ScalarActuator's override status More...
 
void setOverrideActuation (SimTK::State &s, double value) const
 set the actuation value used when the override is true More...
 
double getOverrideActuation (const SimTK::State &s) const
 return override actuation More...
 
const double & get_min_control () const
 Get the value of the min_control property. More...
 
double & upd_min_control ()
 Get a writable reference to the min_control property. More...
 
void set_min_control (const double &value)
 Set the value of the min_control property. More...
 
const double & get_max_control () const
 Get the value of the max_control property. More...
 
double & upd_max_control ()
 Get a writable reference to the max_control property. More...
 
void set_max_control (const double &value)
 Set the value of the max_control property. More...
 
- Public Member Functions inherited from OpenSim::Actuator
 Actuator ()
 
virtual const SimTK::Vector getDefaultControls ()
 Actuator default controls are zero. More...
 
virtual const SimTK::VectorView_< double > getControls (const SimTK::State &s) const
 
virtual void getControls (const SimTK::Vector &modelControls, SimTK::Vector &actuatorControls) const
 Convenience methods for getting, setting and adding to actuator controls from/into the model controls. More...
 
virtual void setControls (const SimTK::Vector &actuatorControls, SimTK::Vector &modelControls) const
 set actuator controls subvector into the right slot in the system-wide model controls More...
 
virtual void addInControls (const SimTK::Vector &actuatorControls, SimTK::Vector &modelControls) const
 add actuator controls to the values already occupying the slot in the system-wide model controls More...
 
virtual void computeEquilibrium (SimTK::State &s) const
 
- Public Member Functions inherited from OpenSim::Force
virtual bool shouldBeParallelized () const
 Tell SimBody to parallelize this force. More...
 
bool appliesForce (const SimTK::State &s) const
 Return if the Force is applied (or enabled) or not. More...
 
void setAppliesForce (SimTK::State &s, bool applyForce) const
 Set whether or not the Force is applied. More...
 
virtual bool hasGeometryPath () const
 Return a flag indicating whether the Force is applied along a Path. More...
 
const bool & get_appliesForce () const
 Get the value of the appliesForce property. More...
 
bool & upd_appliesForce ()
 Get a writable reference to the appliesForce property. More...
 
void set_appliesForce (const bool &value)
 Set the value of the appliesForce property. 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 ModelgetModel () const
 Get a const reference to the Model this component is part of. More...
 
ModelupdModel ()
 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...
 
- 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...
 
Componentoperator= (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 ComponentgetComponent (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)
 
ComponentupdComponent (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...
 
template<class C = Component>
const C * findComponent (const ComponentPath &pathToFind) const
 Find a Component to which this Component is an ancestor—in other words, a Component that is directly owned by this Component or is owned by one of its sub-components, sub-sub-components, etc. More...
 
template<class C = Component>
const C * findComponent (const std::string &pathToFind) const
 Same as findComponent(const ComponentPath&), but accepting a string (a path or just a name) as input. More...
 
const StateVariabletraverseToStateVariable (const std::string &pathName) const
 Get a StateVariable anywhere in the Component tree, given a StateVariable path. 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 ()
 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...
 
const ObjectgetConnectee (const std::string &name) const
 Get the connectee as an Object. More...
 
const AbstractSocketgetSocket (const std::string &name) const
 Get an AbstractSocket for the given socket name. More...
 
AbstractSocketupdSocket (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...
 
void printSubcomponentInfo () const
 List all subcomponents by name and recurse into these components to list their subcomponents, and so on. More...
 
void printSocketInfo () const
 List all the Sockets of this component and whether or not they are connected. More...
 
void printInputInfo () const
 List all the inputs of this component and whether or not they are connected. More...
 
template<typename C >
void printSubcomponentInfo () const
 
void printOutputInfo (const bool includeDescendants=true) const
 Print outputs of this component and optionally, those of all subcomponents. 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 AbstractInputgetInput (const std::string &name) const
 Get an Input provided by this Component by name. More...
 
AbstractInputupdInput (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 AbstractOutputgetOutput (const std::string &name) const
 Get the Output provided by this Component by name. More...
 
AbstractOutputupdOutput (const std::string &name)
 Get a writable reference to an Output provided by this Component by name. More...
 
SimTK::IteratorRange< OutputConstIteratorgetOutputs () const
 Iterate through all Outputs of this component. More...
 
int getModelingOption (const SimTK::State &state, const std::string &name) const
 Get a ModelingOption flag for this Component by name. More...
 
void setModelingOption (SimTK::State &state, const std::string &name, int flag) const
 Set the value of a ModelingOption flag for this Component. More...
 
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...
 
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 getDiscreteVariableValue (const SimTK::State &state, const std::string &name) const
 Get the value of a discrete variable allocated by this Component by name. More...
 
void setDiscreteVariableValue (SimTK::State &state, const std::string &name, double value) const
 Set the value of a discrete variable allocated by this Component by name. More...
 
template<class T >
SimTK::CacheEntryIndex getCacheVariableIndex (const CacheVariable< T > &cv) const
 Get the index of a Component's cache variable in the Subsystem for allocations. More...
 
SimTK::CacheEntryIndex getCacheVariableIndex (const std::string &name) const
 Get the index of a Component's cache variable in the Subsystem for allocations. More...
 
template<class T >
const T & getCacheVariableValue (const SimTK::State &state, const std::string &name) const
 Get the value of a cache variable allocated by this Component by name. More...
 
template<class T >
const T & getCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv) const
 Get the value of a cache variable allocated by this Component. More...
 
template<typename T >
void setCacheVariableValue (const SimTK::State &state, const std::string &k, T value) const
 Set the value of a cache variable, identified by name, to a new value and mark the cache variable as valid. More...
 
template<typename T >
void setCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv, T value) const
 Set the value of a cache variable to a new value and mark the cache variable as valid. More...
 
template<typename T >
T & updCacheVariableValue (const SimTK::State &state, const std::string &name) const
 Returns a mutable reference to the value of a cache variable identified by name. More...
 
template<typename T >
T & updCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv) const
 Returns a mutable reference to the value of a cache variable. More...
 
bool isCacheVariableValid (const SimTK::State &state, const std::string &name) const
 Returns true if the cache variable, identified by name, is valid. More...
 
template<class T >
bool isCacheVariableValid (const SimTK::State &state, const CacheVariable< T > &cv) const
 Returns true if the cache variable is valid. More...
 
void markCacheVariableValid (const SimTK::State &state, const std::string &name) const
 Marks the value of a cache variable, identified by name, as valid. More...
 
template<typename T >
void markCacheVariableValid (const SimTK::State &state, const CacheVariable< T > &cv) const
 Marks the value of a cache variable as valid. More...
 
void markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const
 Marks the value of a cache variable, identified by name, as invalid. More...
 
template<class T >
void markCacheVariableInvalid (const SimTK::State &state, const CacheVariable< T > &cv) const
 Marks the value of a cache variable as invalid. More...
 
const ComponentgetOwner () const
 Access the owner of this Component. More...
 
bool hasOwner () const
 (For advanced users) Check if this Component has an owner. More...
 
const ComponentgetRoot () const
 Obtain the root Component, which is this component if it is orphaned. 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...
 
Objectoperator= (const Object &aObject)
 Copy assignment copies he base class fields, including the properties. More...
 
virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal. More...
 
virtual bool operator< (const Object &aObject) const
 Provide an ordering for objects so they can be put in sorted containers. More...
 
void setName (const std::string &name)
 Set the name of the Object. More...
 
const std::string & getName () const
 Get the name of this Object. More...
 
void setDescription (const std::string &description)
 Set description, a one-liner summary. More...
 
const std::string & getDescription () const
 Get description, a one-liner summary. More...
 
const std::string & getAuthors () const
 Get Authors of this Object. More...
 
void setAuthors (const std::string &authors)
 Set Authors of this object. More...
 
const std::string & getReferences () const
 Get references or publications to cite if using this object. More...
 
void setReferences (const std::string &references)
 Set references or publications to cite if using this object. More...
 
int getNumProperties () const
 Determine how many properties are stored with this Object. More...
 
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByIndex (int propertyIndex)
 Get a writable reference to a property by its index number, returned as an AbstractProperty. More...
 
bool hasProperty (const std::string &name) const
 Return true if this Object has a property of any type with the given name, which must not be empty. More...
 
const AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByName (const std::string &name)
 Get a writable reference to a property by its name, returned as an AbstractProperty. More...
 
template<class T >
bool hasProperty () const
 Return true if this Object contains an unnamed, one-object property that contains objects of the given template type T. More...
 
template<class T >
const Property< T > & getProperty (const PropertyIndex &index) const
 Get property of known type Property<T> as a const reference; the property must be present and have the right type. More...
 
template<class T >
Property< T > & updProperty (const PropertyIndex &index)
 Get property of known type Property<T> as a writable reference; the property must be present and have the right type. More...
 
bool isObjectUpToDateWithProperties () const
 Returns true if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...
 
void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object. More...
 
void updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const
 Serialize this object into the XML node that represents it. More...
 
bool getInlined () const
 Inlined means an in-memory Object that is not associated with an XMLDocument. More...
 
void setInlined (bool aInlined, const std::string &aFileName="")
 Mark this as inlined or not and optionally provide a file name to associate with the new XMLDocument for the non-inline case. More...
 
std::string getDocumentFileName () const
 If there is a document associated with this object then return the file name maintained by the document. More...
 
int getDocumentFileVersion () const
 If there is a document associated with this object then return its version number. More...
 
void setAllPropertiesUseDefault (bool aUseDefault)
 
bool print (const std::string &fileName) const
 Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...
 
std::string dump () const
 dump the XML representation of this Object into an std::string and return it. More...
 
virtual bool isA (const char *type) const
 The default implementation returns true only if the supplied string is "Object"; each Object-derived class overrides this to match its own class name. More...
 
const std::string & toString () const
 Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...
 
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
 
const PropertySetgetPropertySet () const
 

Auto-generated functions

static PointActuatorsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "PointActuator". More...
 
PointActuatorclone () 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::ScalarActuator
static ScalarActuatorsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "ScalarActuator". More...
 
- Static Public Member Functions inherited from OpenSim::Actuator
static ActuatorsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Actuator". More...
 
- Static Public Member Functions inherited from OpenSim::Force
static ForcesafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Force". More...
 
- Static Public Member Functions inherited from OpenSim::ModelComponent
static ModelComponentsafeDownCast (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 ComponentsafeDownCast (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 ObjectgetDefaultInstanceOfType (const std::string &concreteClassName)
 Return a pointer to the default instance of the registered (concrete) Object whose class name is given, or NULL if the type is not registered. More...
 
template<class T >
static bool isObjectTypeDerivedFrom (const std::string &concreteClassName)
 Return true if the given concrete object type represents a subclass of the template object type T, and thus could be referenced with a T*. More...
 
static ObjectnewInstanceOfType (const std::string &concreteClassName)
 Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...
 
static void getRegisteredTypenames (Array< std::string > &typeNames)
 Retrieve all the typenames registered so far. More...
 
template<class T >
static void getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
 Return an array of pointers to the default instances of all registered (concrete) Object types that derive from a given Object-derived type that does not have to be concrete. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
 Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
 Same as the other signature but the class name and property name are provided as two separate strings. More...
 
static ObjectmakeObjectFromFile (const std::string &fileName)
 Create an OpenSim object whose type is based on the tag at the root node of the XML file passed in. More...
 
static const std::string & getClassName ()
 Return the name of this class as a string; i.e., "Object". More...
 
static void setSerializeAllDefaults (bool shouldSerializeDefaults)
 Static function to control whether all registered objects and their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically. More...
 
static bool getSerializeAllDefaults ()
 Report the value of the "serialize all defaults" flag. More...
 
static bool isKindOf (const char *type)
 Returns true if the passed-in string is "Object"; each Object-derived class defines a method of this name for its own class name. More...
 
static void setDebugLevel (int newLevel)
 Set the amount of logging output. More...
 
static int getDebugLevel ()
 Get the current setting of debug level. More...
 
static ObjectSafeCopy (const Object *aObject)
 Use the clone() method to duplicate the given object unless the pointer is null in which case null is returned. More...
 
static void RegisterType (const Object &defaultObject)
 OBSOLETE alternate name for registerType(). More...
 
static void RenameType (const std::string &oldName, const std::string &newName)
 OBSOLETE alternate name for renameType(). More...
 

Detailed Description

A class that implements a point actuator acting on the model.

This actuator has no states; the control is simply the force to be applied to the model.

Author
Ajay Seth

Constructor & Destructor Documentation

◆ PointActuator()

OpenSim::PointActuator::PointActuator ( const std::string &  bodyName = "")
explicit

Default constructor or construct with body name given.

An empty name ("") is treated as though it were unspecified.

Member Function Documentation

◆ clone()

PointActuator* OpenSim::PointActuator::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::ScalarActuator.

◆ get_body()

const std::string& OpenSim::PointActuator::get_body ( ) const
inline

Get the value of the body property.

◆ get_direction()

const SimTK::Vec3& OpenSim::PointActuator::get_direction ( ) const
inline

Get the value of the direction property.

◆ get_force_is_global()

const bool& OpenSim::PointActuator::get_force_is_global ( ) const
inline

Get the value of the force_is_global property.

◆ get_optimal_force()

const double& OpenSim::PointActuator::get_optimal_force ( ) const
inline

Get the value of the optimal_force property.

◆ get_point()

const SimTK::Vec3& OpenSim::PointActuator::get_point ( ) const
inline

Get the value of the point property.

◆ get_point_is_global()

const bool& OpenSim::PointActuator::get_point_is_global ( ) const
inline

Get the value of the point_is_global property.

◆ getClassName()

static const std::string& OpenSim::PointActuator::getClassName ( )
inlinestatic

This returns "PointActuator".

See getConcreteClassName() if you want the class name of the underlying concrete object instead.

◆ getConcreteClassName()

const std::string& OpenSim::PointActuator::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::ScalarActuator.

◆ getOptimalForce()

double OpenSim::PointActuator::getOptimalForce ( ) const
overridevirtual

Get the current value of the 'optimal_force' property.

Reimplemented from OpenSim::ScalarActuator.

◆ safeDownCast()

static PointActuator* OpenSim::PointActuator::safeDownCast ( OpenSim::Object obj)
inlinestatic

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

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

◆ set_body()

void OpenSim::PointActuator::set_body ( const std::string &  value)
inline

Set the value of the body property.

◆ set_direction()

void OpenSim::PointActuator::set_direction ( const SimTK::Vec3 &  value)
inline

Set the value of the direction property.

◆ set_force_is_global()

void OpenSim::PointActuator::set_force_is_global ( const bool &  value)
inline

Set the value of the force_is_global property.

◆ set_optimal_force()

void OpenSim::PointActuator::set_optimal_force ( const double &  value)
inline

Set the value of the optimal_force property.

◆ set_point()

void OpenSim::PointActuator::set_point ( const SimTK::Vec3 &  value)
inline

Set the value of the point property.

◆ set_point_is_global()

void OpenSim::PointActuator::set_point_is_global ( const bool &  value)
inline

Set the value of the point_is_global property.

◆ setOptimalForce()

void OpenSim::PointActuator::setOptimalForce ( double  aOptimalForce)

Set the 'optimal_force' property.

◆ upd_body()

std::string& OpenSim::PointActuator::upd_body ( )
inline

Get a writable reference to the body property.

◆ upd_direction()

SimTK::Vec3& OpenSim::PointActuator::upd_direction ( )
inline

Get a writable reference to the direction property.

◆ upd_force_is_global()

bool& OpenSim::PointActuator::upd_force_is_global ( )
inline

Get a writable reference to the force_is_global property.

◆ upd_optimal_force()

double& OpenSim::PointActuator::upd_optimal_force ( )
inline

Get a writable reference to the optimal_force property.

◆ upd_point()

SimTK::Vec3& OpenSim::PointActuator::upd_point ( )
inline

Get a writable reference to the point property.

◆ upd_point_is_global()

bool& OpenSim::PointActuator::upd_point_is_global ( )
inline

Get a writable reference to the point_is_global property.

OpenSim Property, Socket, Output, Input Documentation

◆ body

std::string OpenSim::PointActuator::body

"Name of Body to which this actuator is applied."

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

See also
get_body(), upd_body(), set_body()

◆ direction

SimTK::Vec3 OpenSim::PointActuator::direction

"Force application direction; in body frame unless " "force_is_global=true."

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

See also
get_direction(), upd_direction(), set_direction()

◆ force_is_global

bool OpenSim::PointActuator::force_is_global

"Interpret direction in Ground frame if true; otherwise, body frame."

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

See also
get_force_is_global(), upd_force_is_global(), set_force_is_global()

◆ optimal_force

double OpenSim::PointActuator::optimal_force

"The maximum force produced by this actuator when fully activated."

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

See also
get_optimal_force(), upd_optimal_force(), set_optimal_force()

◆ point

SimTK::Vec3 OpenSim::PointActuator::point

"Location of application point; in body frame unless " "point_is_global=true"

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

See also
get_point(), upd_point(), set_point()

◆ point_is_global

bool OpenSim::PointActuator::point_is_global

"Interpret point in Ground frame if true; otherwise, body frame."

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

See also
get_point_is_global(), upd_point_is_global(), set_point_is_global()

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