Public Member Functions |
| PiecewiseConstantFunction () |
| PiecewiseConstantFunction (int aN, const double *aTimes, const double *aValues, const std::string &aName="") |
| PiecewiseConstantFunction (const PiecewiseConstantFunction &aFunction) |
virtual | ~PiecewiseConstantFunction () |
virtual void | init (Function *aFunction) |
PiecewiseConstantFunction & | operator= (const PiecewiseConstantFunction &aFunction) |
int | getSize () const |
const Array< double > & | getX () const |
const Array< double > & | getY () const |
virtual const double * | getXValues () const |
virtual const double * | getYValues () const |
virtual int | getNumberOfPoints () const |
virtual double | getX (int aIndex) const |
virtual double | getY (int aIndex) const |
virtual double | getZ (int aIndex) const |
virtual void | setX (int aIndex, double aValue) |
virtual void | setY (int aIndex, double aValue) |
virtual bool | deletePoint (int aIndex) |
virtual bool | deletePoints (const Array< int > &indices) |
virtual int | addPoint (double aX, double aY) |
virtual double | evaluateTotalFirstDerivative (double aX, double aDxdt) const |
virtual double | evaluateTotalSecondDerivative (double aX, double aDxdt, double aD2xdt2) const |
double | calcValue (const SimTK::Vector &x) const |
| Calculate the value of this function at a particular point.
|
double | calcDerivative (const std::vector< int > &derivComponents, const SimTK::Vector &x) const |
| Calculate a partial derivative of this function at a particular point.
|
int | getArgumentSize () const |
| Get the number of components expected in the input vector.
|
int | getMaxDerivativeOrder () const |
| Get the maximum derivative order this Function object can calculate.
|
SimTK::Function * | createSimTKFunction () const |
| Function () |
| Function (const Function &aFunction) |
virtual | ~Function () |
Function & | operator= (const Function &aFunction) |
virtual | ~Object () |
| Virtual destructor for cleanup.
|
virtual Object * | clone () const =0 |
| Create a new heap-allocated copy of the concrete object to which this
Object refers.
|
virtual const std::string & | getConcreteClassName () const =0 |
| Returns the class name of the concrete %Object-derived class of the
actual object referenced by this Object, as a string.
|
virtual const VisibleObject * | getDisplayer () const |
| Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
|
virtual VisibleObject * | updDisplayer () |
| get Non const pointer to VisibleObject
|
bool | isEqualTo (const Object &aObject) const |
| Equality operator wrapper for use from languages not supporting operator overloading.
|
Object & | operator= (const Object &aObject) |
| Copy assignment copies he base class fields, including the
properties.
|
virtual bool | operator== (const Object &aObject) const |
| Determine if two objects are equal.
|
virtual bool | operator< (const Object &aObject) const |
| Provide an ordering for objects so they can be put in sorted
containers.
|
void | setName (const std::string &name) |
| Set the name of the Object.
|
const std::string & | getName () const |
| Get the name of this Object.
|
void | setDescription (const std::string &description) |
| Set description, a one-liner summary.
|
const std::string & | getDescription () const |
| Get description, a one-liner summary.
|
const std::string & | getAuthors () const |
| Get Authors of this Object.
|
void | setAuthors (const std::string &authors) |
| Set Authors of this object, call this method in your constructor if needed.
|
const std::string & | getReferences () const |
| Get references or publications to cite if using this object.
|
void | setReferences (const std::string &references) |
| Set references or publications to cite if using this object.
|
int | getNumProperties () const |
| Determine how many properties are stored with this Object.
|
const AbstractProperty & | getPropertyByIndex (int propertyIndex) const |
| Get a const reference to a property by its index number, returned as
an AbstractProperty.
|
AbstractProperty & | updPropertyByIndex (int propertyIndex) |
| Get a writable reference to a property by its index number, returned as
an AbstractProperty.
|
bool | hasProperty (const std::string &name) const |
| Return true if this %Object has a property of any type with the
given name, which must not be empty.
|
const AbstractProperty & | getPropertyByName (const std::string &name) const |
| Get a const reference to a property by its name, returned as
an AbstractProperty.
|
AbstractProperty & | updPropertyByName (const std::string &name) |
| Get a writable reference to a property by its name, returned as
an AbstractProperty.
|
template<class T > |
bool | hasProperty () const |
| Return true if this %Object contains an unnamed, one-object property
that contains objects of the given template type T.
|
template<class T > |
const Property< T > & | getProperty (const PropertyIndex &index) const |
| Get property of known type Property\<T> as a const reference;
the property must be present and have the right type.
|
template<class T > |
Property< T > & | updProperty (const PropertyIndex &index) |
| Get property of known type Property\<T> as a writable reference;
the property must be present and have the right type.
|
void | setObjectIsUpToDateWithProperties () |
| When an object is initialized using the current values of its
properties, it can set a flag indicating that it is up to date.
|
bool | isObjectUpToDateWithProperties () const |
| Returns \c true if any property's value has changed since the last time
setObjectIsUpToDateWithProperties() was called.
|
void | readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber) |
| We're given an XML element from which we are to populate this Object.
|
virtual void | updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber) |
| Use this method to deserialize an object from a SimTK::Xml::Element.
|
virtual void | updateXMLNode (SimTK::Xml::Element &parent) |
| Serialize this object into the XML node that represents it.
|
bool | getInlined () const |
| Inlined means an in-memory Object that is not associated with
an XMLDocument.
|
void | setInlined (bool aInlined, const std::string &aFileName="") |
| Mark this as inlined or not and optionally provide a file name
to associate with the new XMLDocument for the non-inline case.
|
std::string | getDocumentFileName () const |
| If there is a document associated with this object then return the
file name maintained by the document.
|
void | setAllPropertiesUseDefault (bool aUseDefault) |
bool | print (const std::string &fileName) |
| Write this %Object into an XML file of the given name; conventionally
the suffix to use is ".osim".
|
std::string | dump (bool dumpName=false) |
| dump the XML representation of this Object into an std::string and return it.
|
void | clearObjectIsUpToDateWithProperties () |
| For testing or debugging purposes, manually clear the "object is up to
date with respect to properties" flag.
|
virtual bool | isA (const char *type) const |
| The default implementation returns true only if the supplied string
is "Object"; each Object-derived class overrides this to match its own class name.
|
const std::string & | toString () const |
| Wrapper to be used on Java side to display objects in tree; this returns
just the object's name.
|
PropertySet & | getPropertySet () |
| OBSOLETE: Get a reference to the PropertySet maintained by the
Object.
|
const PropertySet & | getPropertySet () const |