|
| PolynomialFunction () |
| Construct a polynomial with default coefficients of {1}. More...
|
|
| PolynomialFunction (SimTK::Vector coefficients) |
| Construct a polynomial with provided Vector of coefficients {a, b, ..., c} where the polynomial order, n = size-1. More...
|
|
virtual | ~PolynomialFunction () |
|
void | setCoefficients (SimTK::Vector coefficients) |
| Set coefficients for the polynomial f of variable x: f(x) = a*x^n + b*x^(n-1) + ... More...
|
|
const SimTK::Vector | getCoefficients () const |
| Get the polynomial function coefficients. More...
|
|
virtual SimTK::Function * | createSimTKFunction () const |
| Return the underlying SimTK::Function::Polynomial for direct use at the SimTK::System level. More...
|
|
| Function () |
|
| Function (const Function &aFunction) |
|
virtual | ~Function () |
|
virtual void | init (Function *aFunction) |
|
Function & | operator= (const Function &aFunction) |
|
virtual double | calcValue (const SimTK::Vector &x) const |
| Calculate the value of this function at a particular point. More...
|
|
virtual double | calcDerivative (const std::vector< int > &derivComponents, const SimTK::Vector &x) const |
| Calculate a partial derivative of this function at a particular point. More...
|
|
virtual int | getArgumentSize () const |
| Get the number of components expected in the input vector. More...
|
|
virtual int | getMaxDerivativeOrder () const |
| Get the maximum derivative order this Function object can calculate. More...
|
|
virtual | ~Object () |
| Virtual destructor for cleanup. More...
|
|
virtual Object * | clone () const =0 |
| Create a new heap-allocated copy of the concrete object to which this Object refers. More...
|
|
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. More...
|
|
virtual const VisibleObject * | getDisplayer () const |
| Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects. More...
|
|
virtual VisibleObject * | updDisplayer () |
| get Non const pointer to VisibleObject More...
|
|
bool | isEqualTo (const Object &aObject) const |
| Equality operator wrapper for use from languages not supporting operator overloading. More...
|
|
Object & | operator= (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, call this method in your constructor if needed. 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 AbstractProperty & | getPropertyByIndex (int propertyIndex) const |
| Get a const reference to a property by its index number, returned as an AbstractProperty. More...
|
|
AbstractProperty & | updPropertyByIndex (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 AbstractProperty & | getPropertyByName (const std::string &name) const |
| Get a const reference to a property by its name, returned as an AbstractProperty. More...
|
|
AbstractProperty & | updPropertyByName (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...
|
|
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...
|
|
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...
|
|
virtual void | updateXMLNode (SimTK::Xml::Element &parent) |
| 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...
|
|
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". More...
|
|
std::string | dump (bool dumpName=false) |
| dump the XML representation of this Object into an std::string and return it. More...
|
|
void | clearObjectIsUpToDateWithProperties () |
| For testing or debugging purposes, manually clear the "object is up to
date with respect to properties" flag. 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...
|
|
PropertySet & | getPropertySet () |
| OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
|
|
const PropertySet & | getPropertySet () const |
|
A class for representing a Polynomial of x.
f(x) = a*x^n + b*x^(n-1) + ... + c
Order of the coeficients corresponds to decreasing powers.
- Author
- Carmichael Ong