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

A class that represents a constant control curve. More...

+ Inheritance diagram for OpenSim::ControlConstant:

Public Member Functions

 ControlConstant (double aX=0.0, const char *aName="UNKNOWN")
 
 ControlConstant (const ControlConstant &aControl)
 
virtual ~ControlConstant ()
 
ControlConstantoperator= (const ControlConstant &aControl)
 
int getNumParameters () const override
 Returns the number of parameters that are used to specify the control curve. More...
 
void setParameterMin (int aI, double aMin) override
 Sets the minimum value that a control parameter can take on. More...
 
double getParameterMin (int aI) const override
 
void setParameterMax (int aI, double aMax) override
 Set the maximum value that a control parameter can take on. More...
 
double getParameterMax (int aI) const override
 
double getParameterTime (int aI) const override
 For ControlConstant, parameters are not associated with any specific time. More...
 
void getParameterNeighborhood (int aI, double &rTLower, double &rTUpper) const override
 
int getParameterList (double aT, Array< int > &rList) override
 
int getParameterList (double aT1, double aT2, Array< int > &rList) override
 Gets the list of parameters that affect the control curve between two specified times and that do NOT affect the control curve below the lower of these two times. More...
 
void setParameterValue (int aI, double aX) override
 
double getParameterValue (int aI) const override
 
void setControlValue (double aT, double aX) override
 
double getControlValue (double aT) override
 
double getControlValueMin (double aT=0.0) override
 Gets the minimum allowed value of this control at time aT. More...
 
void setControlValueMin (double aT, double aX) override
 Sets the minimum value of this control curve at time aT. More...
 
double getControlValueMax (double aT=0.0) override
 Gets the maximum allowed value of this control at time aT. More...
 
void setControlValueMax (double aT, double aX) override
 Sets the maximum value of this control curve at time aT. More...
 
- Public Member Functions inherited from OpenSim::Control
 Control (const char *aName="UNKNOWN")
 
 Control (const Control &aControl)
 
virtual ~Control ()
 
Controloperator= (const Control &aControl)
 
void setIsModelControl (bool aTrueFalse)
 Sets whether or not this control is a model control. More...
 
bool getIsModelControl () const
 
void setExtrapolate (bool aTrueFalse)
 Sets whether or not to extrapolate for control curve evaluations that are outside the region of confidence for a control. More...
 
bool getExtrapolate () const
 
void setFilterOn (bool aTrueFalse)
 Sets whether or not to apply a PD (proportional-derivative) filter to the control values. More...
 
bool getFilterOn () const
 
void setDefaultParameterMin (double aMin)
 Sets the default minimum value of a control parameter. More...
 
double getDefaultParameterMin () const
 
void setDefaultParameterMax (double aMax)
 Sets the default maximum value of a control parameter. More...
 
double getDefaultParameterMax () const
 
virtual double getFirstTime () const
 Gets the first time for which a parameter is specified. More...
 
virtual double getLastTime () const
 Gets the last time for which a parameter is specified. More...
 
virtual void simplify (const PropertySet &aProperties)
 Simplify the control (e.g., reduce the number of points in the control curve) based on a set of specified properties. More...
 
virtual void filter (double aT)
 Filter the control curve at a particular time. 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...
 
virtual void updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
 Use this method to deserialize an object from a SimTK::Xml::Element. 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 ControlConstantsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "ControlConstant". More...
 
ControlConstantclone () 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::Control
static ControlsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Control". 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 represents a constant control curve.

That is, the value of the control curve is the same at any value of time.

Author
Frank C. Anderson
Version
1.0

Constructor & Destructor Documentation

◆ ControlConstant() [1/2]

OpenSim::ControlConstant::ControlConstant ( double  aX = 0.0,
const char *  aName = "UNKNOWN" 
)
Parameters
aXConstant value of the control.
aNameName of the control.

◆ ControlConstant() [2/2]

OpenSim::ControlConstant::ControlConstant ( const ControlConstant aControl)

◆ ~ControlConstant()

virtual OpenSim::ControlConstant::~ControlConstant ( )
virtual

Member Function Documentation

◆ clone()

ControlConstant* OpenSim::ControlConstant::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::Control.

◆ getClassName()

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

This returns "ControlConstant".

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

◆ getConcreteClassName()

const std::string& OpenSim::ControlConstant::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::Control.

◆ getControlValue()

double OpenSim::ControlConstant::getControlValue ( double  aT)
overridevirtual
Parameters
aTNot used since the control value is constant in time.

Implements OpenSim::Control.

◆ getControlValueMax()

double OpenSim::ControlConstant::getControlValueMax ( double  aT = 0.0)
overridevirtual

Gets the maximum allowed value of this control at time aT.

Parameters
aTTime at which to get the control.
Returns
Maximum allowed control value. If the value of the curve is not defined, _defaultMax is returned. If the control is set to extrapolate, getExtraplate, and the time is before the first node or after the last node, then an extrapolation is performed to determine the value of the control curve. Otherwise, the value of either the first control node or last control node is returned.

Implements OpenSim::Control.

◆ getControlValueMin()

double OpenSim::ControlConstant::getControlValueMin ( double  aT = 0.0)
overridevirtual

Gets the minimum allowed value of this control at time aT.

Parameters
aTTime at which to get the control.
Returns
Minimum allowed control value. If the value of the curve is not defined, _defaultMin is returned. If the control is set to extrapolate, (see getExtraplate()), and the time is before the first node or after the last node, then an extrapolation is performed to determine the value of the control curve. Otherwise, the value of either the first control node or last control node is returned.

Implements OpenSim::Control.

◆ getNumParameters()

int OpenSim::ControlConstant::getNumParameters ( ) const
overridevirtual

Returns the number of parameters that are used to specify the control curve.

Implements OpenSim::Control.

◆ getParameterList() [1/2]

int OpenSim::ControlConstant::getParameterList ( double  aT,
Array< int > &  rList 
)
overridevirtual
Parameters
aTtime
rListParameter at index 0 (i.e., the value of the constant) is the only parameter on the list.

Implements OpenSim::Control.

◆ getParameterList() [2/2]

int OpenSim::ControlConstant::getParameterList ( double  aTLower,
double  aTUpper,
Array< int > &  rList 
)
overridevirtual

Gets the list of parameters that affect the control curve between two specified times and that do NOT affect the control curve below the lower of these two times.

This method is useful when solving for a set of controls for a dynamic simulation. When solving for a set of controls, one always wants to go forward in time. Therefore, one does not want to change control parameters that affect the control curve at past times.

A control parameter is included in the list only if it affects the control curve in the specified time interval AND does NOT affect the control curve below the lower bound of the specified time interval. So, it is possible that some of the parameters on the returned list could affect the control curve at times greater than the upper bound of the specified time interval.

Parameters
aTLowerLower time bound.
aTUpperUpper time bound.
rListList of indices of the control parameters that affect the curve between aTLower and aTUpper but not before aTLower.
Returns
Length of rList.

Implements OpenSim::Control.

◆ getParameterMax()

double OpenSim::ControlConstant::getParameterMax ( int  aI) const
overridevirtual
See also
setParameterMax()
Parameters
aIIndex of the parameter.
Exceptions
Exceptionif aI is invalid.

Implements OpenSim::Control.

◆ getParameterMin()

double OpenSim::ControlConstant::getParameterMin ( int  aI) const
overridevirtual
See also
setParameterMin()
Parameters
aIIndex of the parameter for which the minimum value is desired.
Exceptions
Exceptionif aI is invalid.

Implements OpenSim::Control.

◆ getParameterNeighborhood()

void OpenSim::ControlConstant::getParameterNeighborhood ( int  aI,
double &  rTLower,
double &  rTUpper 
) const
overridevirtual
Parameters
aIIndex of the parameter.
rTLower-SimTK::Infinity
rTUpperSimTK::Infinity

Implements OpenSim::Control.

◆ getParameterTime()

double OpenSim::ControlConstant::getParameterTime ( int  aI) const
overridevirtual

For ControlConstant, parameters are not associated with any specific time.

Parameters
aIIndex of the parameter.
Returns
SimTK::NaN

Implements OpenSim::Control.

◆ getParameterValue()

double OpenSim::ControlConstant::getParameterValue ( int  aI) const
overridevirtual
See also
setParameterValue()
Parameters
aIOnly 0 is valid for ControlConstant.
Returns
The constant value of this control curve.

Implements OpenSim::Control.

◆ operator=()

ControlConstant& OpenSim::ControlConstant::operator= ( const ControlConstant aControl)

◆ safeDownCast()

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

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

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

◆ setControlValue()

void OpenSim::ControlConstant::setControlValue ( double  aT,
double  aX 
)
overridevirtual
Parameters
aTNot used since the control value is constant in time.
aXControl value.

Implements OpenSim::Control.

◆ setControlValueMax()

void OpenSim::ControlConstant::setControlValueMax ( double  aT,
double  aMax 
)
overridevirtual

Sets the maximum value of this control curve at time aT.

Parameters
aTTime at which to set the control.
aMaxMaximum allowed control value.

Implements OpenSim::Control.

◆ setControlValueMin()

void OpenSim::ControlConstant::setControlValueMin ( double  aT,
double  aMin 
)
overridevirtual

Sets the minimum value of this control curve at time aT.

Parameters
aTTime at which to set the control.
aMinMinimum allowed control value at time aT.

Implements OpenSim::Control.

◆ setParameterMax()

void OpenSim::ControlConstant::setParameterMax ( int  aI,
double  aMax 
)
overridevirtual

Set the maximum value that a control parameter can take on.

Parameters
aIIndex of the parameter.
aMaxMaximum value the parameter can have.
Exceptions
Exceptionif aI is invalid.

Implements OpenSim::Control.

◆ setParameterMin()

void OpenSim::ControlConstant::setParameterMin ( int  aI,
double  aMin 
)
overridevirtual

Sets the minimum value that a control parameter can take on.

Parameters
aIIndex of the parameter.
aMinMinimum value the parameter can have.
Exceptions
Exceptionif aI is invalid.

Implements OpenSim::Control.

◆ setParameterValue()

void OpenSim::ControlConstant::setParameterValue ( int  aI,
double  aX 
)
overridevirtual
Parameters
aIOnly 0 is valid for ControlConstant.
aXThe constant value of this control curve.

Implements OpenSim::Control.

◆ setupProperties()

void OpenSim::ControlConstant::setupProperties ( )
overrideprotectedvirtual

Reimplemented from OpenSim::Control.


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