OpenSim  OpenSim 3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::MultiplierFunction Class Reference

#include <MultiplierFunction.h>

Inheritance diagram for OpenSim::MultiplierFunction:
OpenSim::Function OpenSim::Object

Public Member Functions

 MultiplierFunction ()
 MultiplierFunction (Function *aFunction)
 MultiplierFunction (Function *aFunction, double aScaleFactor)
 MultiplierFunction (const MultiplierFunction &aFunction)
virtual ~MultiplierFunction ()
virtual void init (Function *aFunction)
MultiplierFunctionoperator= (const MultiplierFunction &aFunction)
void setFunction (Function *aFunction)
void setScale (double aScaleFactor)
FunctiongetFunction () const
double getScale () 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
- Public Member Functions inherited from OpenSim::Function
 Function ()
 Function (const Function &aFunction)
virtual ~Function ()
Functionoperator= (const Function &aFunction)
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup.
virtual Objectclone () 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 VisibleObjectgetDisplayer () const
 Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
virtual VisibleObjectupdDisplayer ()
 get Non const pointer to VisibleObject
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading.
Objectoperator= (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 AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty.
AbstractPropertyupdPropertyByIndex (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 AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty.
AbstractPropertyupdPropertyByName (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 true if no 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.
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object.
const PropertySetgetPropertySet () const

Protected Attributes

PropertyObjPtr< OpenSim::Function_osFunctionProp
 The Function this object operates on.
Function *& _osFunction
PropertyDbl _scaleProp
 Scale factor.
double & _scale
- Protected Attributes inherited from OpenSim::Function
SimTK::Function * _function
- Protected Attributes inherited from OpenSim::Object
PropertySet _propertySet
 OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes.

Additional Inherited Members

- Static Public Member Functions inherited from OpenSim::Function
static FunctionmakeFunctionOfType (Function *aFunction, const std::string &aNewTypeName)
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized.
- Protected Member Functions inherited from OpenSim::Function
void resetFunction ()
 This should be called whenever this object has been modified.

Constructor & Destructor Documentation

OpenSim::MultiplierFunction::MultiplierFunction ( )
OpenSim::MultiplierFunction::MultiplierFunction ( Function aFunction)
OpenSim::MultiplierFunction::MultiplierFunction ( Function aFunction,
double  aScaleFactor 
)
OpenSim::MultiplierFunction::MultiplierFunction ( const MultiplierFunction aFunction)
virtual OpenSim::MultiplierFunction::~MultiplierFunction ( )
virtual

Member Function Documentation

double OpenSim::MultiplierFunction::calcDerivative ( const std::vector< int > &  derivComponents,
const SimTK::Vector &  x 
) const
virtual

Calculate a partial derivative of this function at a particular point.

Which derivative to take is specified by listing the input components with which to take it. For example, if derivComponents=={0}, that indicates a first derivative with respective to component 0. If derivComponents=={0, 0, 0}, that indicates a third derivative with respective to component 0. If derivComponents=={4, 7}, that indicates a partial second derivative with respect to components 4 and 7.

Parameters
derivComponentsthe input components with respect to which the derivative should be taken. Its size must be less than or equal to the value returned by getMaxDerivativeOrder().
xthe Vector of input arguments. Its size must equal the value returned by getArgumentSize().

Reimplemented from OpenSim::Function.

double OpenSim::MultiplierFunction::calcValue ( const SimTK::Vector &  x) const
virtual

Calculate the value of this function at a particular point.

Parameters
xthe Vector of input arguments. Its size must equal the value returned by getArgumentSize().

Reimplemented from OpenSim::Function.

SimTK::Function* OpenSim::MultiplierFunction::createSimTKFunction ( ) const
virtual

Implements OpenSim::Function.

int OpenSim::MultiplierFunction::getArgumentSize ( ) const
virtual

Get the number of components expected in the input vector.

Reimplemented from OpenSim::Function.

Function* OpenSim::MultiplierFunction::getFunction ( ) const
inline
int OpenSim::MultiplierFunction::getMaxDerivativeOrder ( ) const
virtual

Get the maximum derivative order this Function object can calculate.

Reimplemented from OpenSim::Function.

double OpenSim::MultiplierFunction::getScale ( ) const
inline
virtual void OpenSim::MultiplierFunction::init ( Function aFunction)
virtual

Reimplemented from OpenSim::Function.

MultiplierFunction& OpenSim::MultiplierFunction::operator= ( const MultiplierFunction aFunction)
void OpenSim::MultiplierFunction::setFunction ( Function aFunction)
void OpenSim::MultiplierFunction::setScale ( double  aScaleFactor)

Member Data Documentation

Function*& OpenSim::MultiplierFunction::_osFunction
protected
PropertyObjPtr<OpenSim::Function> OpenSim::MultiplierFunction::_osFunctionProp
protected

The Function this object operates on.

double& OpenSim::MultiplierFunction::_scale
protected
PropertyDbl OpenSim::MultiplierFunction::_scaleProp
protected

Scale factor.


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