API  4.5
For C++ developers
OpenSim::MocoPathConstraint Class Referenceabstract

A path constraint to be enforced in the optimal control problem. More...

+ Inheritance diagram for OpenSim::MocoPathConstraint:

OpenSim Properties, Sockets, Outputs, Inputs

Properties (unnamed)
MocoConstraintInfo MocoConstraintInfo
 "The bounds and labels for this MocoPathConstraint." More...
 

Public Member Functions

 MocoPathConstraint ()
 
const MocoConstraintInfogetConstraintInfo () const
 
MocoConstraintInfoupdConstraintInfo ()
 
void setConstraintInfo (const MocoConstraintInfo &cInfo)
 
int getPathConstraintIndex () const
 For use by solvers. More...
 
void calcPathConstraintErrors (const SimTK::State &state, SimTK::Vector &errors) const
 Calculate errors in the path constraint equations. More...
 
void calcPathConstraintErrorsView (const SimTK::State &state, SimTK::Vector &errors) const
 Calculate errors in the path constraint equations. More...
 
void initializeOnModel (const Model &model, const MocoProblemInfo &, const int &pathConstraintIndex) const
 Perform error checks on user input for this constraint, and cache quantities needed when computing the constraint errors. More...
 
void printDescription () const
 Print the description for this path constraint. 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 >
const Property< T > & getPropertyByName (const std::string &name) 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...
 
template<class T >
Property< T > & updPropertyByName (const std::string &name)
 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
 

Public Types

typedef MocoPathConstraint Self
 This typedef might be useful within the member functions of this class. More...
 
typedef Object Super
 Use this typedef to refer to the superclass of this class. More...
 

Protected Member Functions

virtual void initializeOnModelImpl (const Model &, const MocoProblemInfo &) const =0
 Perform any caching. More...
 
void setNumEquations (int numEqs) const
 Set the number of scalar equations for this MocoPathConstraint. More...
 
virtual void calcPathConstraintErrorsImpl (const SimTK::State &state, SimTK::Vector &errors) const =0
 
virtual void printDescriptionImpl () const
 Print a more detailed description unique to each path constraint. More...
 
const ModelgetModel () const
 For use within virtual function implementations. More...
 
Property-related functions
const MocoConstraintInfoget_MocoConstraintInfo () const
 Get the value of the MocoConstraintInfo property. More...
 
MocoConstraintInfoupd_MocoConstraintInfo ()
 Get a writable reference to the MocoConstraintInfo property. More...
 
void set_MocoConstraintInfo (const MocoConstraintInfo &value)
 Set the value of the MocoConstraintInfo property. More...
 
- Protected Member Functions inherited from OpenSim::Object
 Object ()
 The default constructor is only for use by constructors of derived types. More...
 
 Object (const std::string &fileName, bool aUpdateFromXMLNode=true)
 Constructor from a file, to be called from other constructors that take a file as input. More...
 
 Object (const Object &source)
 Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly. More...
 
 Object (SimTK::Xml::Element &aElement)
 Construct the base class portion of an Object from a given Xml element that describes this Object. More...
 
template<class T >
PropertyIndex addProperty (const std::string &name, const std::string &comment, const T &value)
 Define a new single-value property of known type T, with the given name, associated comment, and initial value. More...
 
template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment)
 Add an optional property, meaning it can contain either no value or a single value. More...
 
template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment, const T &value)
 Add an optional property, meaning it can contain either no value or a single value. More...
 
template<class T >
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize)
 Define a new list-valued property of known type T, with the given name, associated comment, minimum (==0) and maximum (>0) allowable list lengths, and a zero-length initial value. More...
 
template<class T , template< class > class Container>
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize, const Container< T > &valueList)
 Define a new list-valued property as above, but assigning an initial value via some templatized container class that supports size() and indexing. More...
 
PropertyIndex getPropertyIndex (const std::string &name) const
 Look up a property by name and return its PropertyIndex if it is found. More...
 
template<class T >
PropertyIndex getPropertyIndex () const
 Look up an unnamed property by the type of object it contains, and return its PropertyIndex if it is found. More...
 
template<class T >
void checkPropertyValueIsPositive (const Property< T > &p) const
 Throw an exception if any of the property's values are not positive. More...
 
template<class T >
void checkPropertyValueIsInSet (const Property< T > &p, const std::set< T > &set) const
 Throw an exception if any of the property's values are not in the provided set. More...
 
template<class T >
void checkPropertyValueIsInRangeOrSet (const Property< T > &p, const T &lower, const T &upper, const std::set< T > &set) const
 Throw an exception if any of the property's values are neither in the provided range nor in the provided set. More...
 
void setObjectIsUpToDateWithProperties ()
 When an object is initialized using the current values of its properties, it can set a flag indicating that it is up to date. More...
 
void clearObjectIsUpToDateWithProperties ()
 For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag. More...
 
void makeObjectNamesConsistentWithProperties ()
 Make sure the name of an object is consistent with its property type. More...
 
void updateFromXMLDocument ()
 Use this method only if you're deserializing from a file and the object is at the top level; that is, primarily in constructors that take a file name as input. More...
 
void setDocument (XMLDocument *doc)
 Unconditionally set the XMLDocument associated with this object. More...
 
const XMLDocumentgetDocument () const
 Get a const pointer to the document (if any) associated with this object. More...
 
XMLDocumentupdDocument ()
 Get a writable pointer to the document (if any) associated with this object. More...
 

Auto-generated functions

static MocoPathConstraintsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "MocoPathConstraint". More...
 
void assign (Object &aObject) override
 This allows copy assignment in the Java GUI. More...
 
MocoPathConstraintclone () const override=0
 Create a new heap-allocated copy of the concrete object to which this Object refers. More...
 
const std::string & getConcreteClassName () const override=0
 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::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...
 
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized. More...
 
- Protected Attributes inherited from OpenSim::Object
PropertySet _propertySet
 OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. More...
 

Detailed Description

A path constraint to be enforced in the optimal control problem.

The use of 'path' here is unrelated to muscle paths, GeometryPath, or file system paths (e.g., Path).

For developers
Every time the problem is solved, a copy of this constraint is used. An individual instance of a constraint is only ever used in a single problem. Therefore, there is no need to clear cache variables that you create in initializeImpl(). Also, information stored in this constraint does not persist across multiple solves.

Member Typedef Documentation

◆ Self

This typedef might be useful within the member functions of this class.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

Use this typedef to refer to the superclass of this class.

Avoid using the explicit type name of the superclass; this would introduce bugs if the superclass is changed.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

Constructor & Destructor Documentation

◆ MocoPathConstraint()

OpenSim::MocoPathConstraint::MocoPathConstraint ( )

Member Function Documentation

◆ assign()

void OpenSim::MocoPathConstraint::assign ( Object aObject)
inlineoverride

This allows copy assignment in the Java GUI.

Exceptions
Exceptionif the argument is not of type MocoPathConstraint.

◆ calcPathConstraintErrors()

void OpenSim::MocoPathConstraint::calcPathConstraintErrors ( const SimTK::State &  state,
SimTK::Vector &  errors 
) const
inline

Calculate errors in the path constraint equations.

The errors argument represents the error vector for this MocoPathConstraint. The errors vector is passed to calcPathConstraintErrorsImpl(), which is defined by derived classes.

Precondition(s):
initializeOnModel() has been invoked.

◆ calcPathConstraintErrorsImpl()

virtual void OpenSim::MocoPathConstraint::calcPathConstraintErrorsImpl ( const SimTK::State &  state,
SimTK::Vector &  errors 
) const
protectedpure virtual
Precondition(s):
The state is realized to SimTK::Stage::Position. If you need access to the controls, you must realize to Velocity:

Implemented in OpenSim::MocoFrameDistanceConstraint, OpenSim::MocoControlBoundConstraint, and OpenSim::MocoOutputConstraint.

◆ calcPathConstraintErrorsView()

void OpenSim::MocoPathConstraint::calcPathConstraintErrorsView ( const SimTK::State &  state,
SimTK::Vector &  errors 
) const
inline

Calculate errors in the path constraint equations.

The errors argument represents the concatenated error vector for all path constraints in the MocoProblem. This method creates a view into errors to access the elements for this MocoPathConstraint and passes this view to calcPathConstraintErrorsImpl().

Precondition(s):
initializeOnModel() has been invoked.

◆ clone()

MocoPathConstraint* OpenSim::MocoPathConstraint::clone ( ) const
overridepure virtual

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::Object.

Implemented in OpenSim::MocoFrameDistanceConstraint, OpenSim::MocoControlBoundConstraint, and OpenSim::MocoOutputConstraint.

◆ get_MocoConstraintInfo()

const MocoConstraintInfo& OpenSim::MocoPathConstraint::get_MocoConstraintInfo ( ) const
inlineprotected

Get the value of the MocoConstraintInfo property.

◆ getClassName()

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

This returns "MocoPathConstraint".

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

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ getConcreteClassName()

const std::string& OpenSim::MocoPathConstraint::getConcreteClassName ( ) const
overridepure virtual

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::Object.

Implemented in OpenSim::MocoFrameDistanceConstraint, OpenSim::MocoControlBoundConstraint, and OpenSim::MocoOutputConstraint.

◆ getConstraintInfo()

const MocoConstraintInfo& OpenSim::MocoPathConstraint::getConstraintInfo ( ) const
inline

◆ getModel()

const Model& OpenSim::MocoPathConstraint::getModel ( ) const
inlineprotected

For use within virtual function implementations.

◆ getPathConstraintIndex()

int OpenSim::MocoPathConstraint::getPathConstraintIndex ( ) const
inline

For use by solvers.

This index is the location of this MocoPathConstraint's first error in the MocoProblem's full path constraint errors vector. Since it is set by the MocoProblem, it is only available after initialization.

◆ initializeOnModel()

void OpenSim::MocoPathConstraint::initializeOnModel ( const Model model,
const MocoProblemInfo ,
const int &  pathConstraintIndex 
) const

Perform error checks on user input for this constraint, and cache quantities needed when computing the constraint errors.

to efficiently evaluate the constraint. This function must be invoked before invoking calcPathConstraintErrors().

◆ initializeOnModelImpl()

virtual void OpenSim::MocoPathConstraint::initializeOnModelImpl ( const Model ,
const MocoProblemInfo  
) const
protectedpure virtual

Perform any caching.

The number of scalar constraint equations this MocoPathConstraint implements must be defined here (see setNumEquations() below).

Precondition(s):
The model is initialized (initSystem()) and getModel() is available. The passed-in model is equivalent to getModel(). Use this opportunity to check for errors in user input, in addition to the checks provided in initialize().

Implemented in OpenSim::MocoFrameDistanceConstraint, OpenSim::MocoControlBoundConstraint, and OpenSim::MocoOutputConstraint.

◆ printDescription()

void OpenSim::MocoPathConstraint::printDescription ( ) const

Print the description for this path constraint.

◆ printDescriptionImpl()

virtual void OpenSim::MocoPathConstraint::printDescriptionImpl ( ) const
inlineprotectedvirtual

Print a more detailed description unique to each path constraint.

Reimplemented in OpenSim::MocoOutputConstraint.

◆ safeDownCast()

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

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

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

◆ set_MocoConstraintInfo()

void OpenSim::MocoPathConstraint::set_MocoConstraintInfo ( const MocoConstraintInfo value)
inlineprotected

Set the value of the MocoConstraintInfo property.

◆ setConstraintInfo()

void OpenSim::MocoPathConstraint::setConstraintInfo ( const MocoConstraintInfo cInfo)
inline

◆ setNumEquations()

void OpenSim::MocoPathConstraint::setNumEquations ( int  numEqs) const
inlineprotected

Set the number of scalar equations for this MocoPathConstraint.

This must be set within initializeImpl(), otherwise an exception is thrown during initialization.

◆ upd_MocoConstraintInfo()

MocoConstraintInfo& OpenSim::MocoPathConstraint::upd_MocoConstraintInfo ( )
inlineprotected

Get a writable reference to the MocoConstraintInfo property.

◆ updConstraintInfo()

MocoConstraintInfo& OpenSim::MocoPathConstraint::updConstraintInfo ( )
inline

OpenSim Property, Socket, Output, Input Documentation

◆ MocoConstraintInfo

MocoConstraintInfo OpenSim::MocoPathConstraint::MocoConstraintInfo

"The bounds and labels for this MocoPathConstraint."

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

See also
get_MocoConstraintInfo(), upd_MocoConstraintInfo(), set_MocoConstraintInfo()

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