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

#include <ControlConstant.h>

Inheritance diagram for OpenSim::ControlConstant:

Public Member Functions
	ControlConstant (double aX=0.0, const char *aName="UNKOWN")

	ControlConstant (const ControlConstant &aControl)

virtual	~ControlConstant ()

ControlConstant &	operator= (const ControlConstant &aControl)

virtual int	getNumParameters () const
	Returns the number of parameters that are used to specify the control curve. More...

virtual void	setParameterMin (int aI, double aMin)
	Sets the minimum value that a control parameter can take on. More...

virtual double	getParameterMin (int aI) const

virtual void	setParameterMax (int aI, double aMax)
	Set the maximum value that a control parameter can take on. More...

virtual double	getParameterMax (int aI) const

virtual double	getParameterTime (int aI) const
	For ControlConstant, parameters are not associated with any specific time. More...

virtual void	getParameterNeighborhood (int aI, double &rTLower, double &rTUpper) const

virtual int	getParameterList (double aT, Array< int > &rList)

virtual int	getParameterList (double aT1, double aT2, Array< int > &rList)
	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...

virtual void	setParameterValue (int aI, double aX)

virtual double	getParameterValue (int aI) const

virtual void	setControlValue (double aT, double aX)

virtual double	getControlValue (double aT)

virtual double	getControlValueMin (double aT=0.0)
	Gets the minimum allowed value of this control at time aT. More...

virtual void	setControlValueMin (double aT, double aX)
	Sets the minimum value of this control curve at time aT. More...

virtual double	getControlValueMax (double aT=0.0)
	Gets the maximum allowed value of this control at time aT. More...

virtual void	setControlValueMax (double aT, double aX)
	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 ()

Control &	operator= (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 outide 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 const double	getFirstTime () const
	Gets the first time for which a parameter is specified. More...

virtual const double	getLastTime () const
	Gets the last time for which a arameter 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...

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

Protected Member Functions
void	setupProperties ()

Protected Member Functions inherited from OpenSim::Control
void	copyData (const Control &aControl)
	Copy the member variables of the specified Control over to this Control instance. 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) SWIG_DECLARE_EXCEPTION
	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...

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 XMLDocument *	getDocument () const
	Get a const pointer to the document (if any) associated with this object. More...

XMLDocument *	updDocument ()
	Get a writable pointer to the document (if any) associated with this object. More...

Protected Attributes
PropertyDbl	_propX
	Control value. More...

double &	_x

Protected Attributes inherited from OpenSim::Control
PropertyBool	_propIsModelControl
	Flag that specifies whether or not this control is a model control. More...

PropertyBool	_propExtrapolate
	Flag that specifies whether or not this control should use extrapolation for times outside the time range of the control parameters. More...

PropertyDbl	_propDefaultMin
	Default parameter minimum. More...

PropertyDbl	_propDefaultMax
	Default parameter maximum. More...

PropertyBool	_propFilterOn
	Flat that indicates whether PD follower filter is on. More...

bool &	_isModelControl
	Reference to the value of the IsModelControl property. More...

bool &	_extrapolate
	Reference to the value of the Extrapolate flag. More...

double &	_defaultMin
	Reference to the value of the DefaultMin property. More...

double &	_defaultMax
	Reference to the value of the DefaultMax property. More...

bool &	_filterOn
	Reference to the value of the PropFilterOn property. More...

Protected Attributes inherited from OpenSim::Object
PropertySet	_propertySet
	OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. 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 Object *	getDefaultInstanceOfType (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 Object *	newInstanceOfType (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 void	PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName)
	Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...

static void	PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName)
	Same as the other signature but the class name and property name are provided as two separate strings. More...

static Object *	makeObjectFromFile (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 debug level to get verbose output. More...

static int	getDebugLevel ()
	Get current setting of debug level. More...

static Object *	SafeCopy (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...

Related Functions inherited from OpenSim::Object
#define	OpenSim_DECLARE_CONCRETE_OBJECT(ConcreteClass, SuperClass)
	Macro to be included as the first line of the class declaration for any non-templatized, concrete class that derives from OpenSim::Object. More...

#define	OpenSim_DECLARE_ABSTRACT_OBJECT(ConcreteClass, SuperClass)
	Macro to be included as the first line of the class declaration for any still-abstract class that derives from OpenSim::Object. More...

#define	OpenSim_DECLARE_CONCRETE_OBJECT_T(ConcreteClass, TArg, SuperClass)
	Macro to be included as the first line of the class declaration for any templatized, concrete class that derives from OpenSim::Object, like Set<T>. More...

#define	OpenSim_DECLARE_ABSTRACT_OBJECT_T(ConcreteClass, TArg, SuperClass)
	Macro to be included as the first line of the class declaration for any templatized, still-abstract class that derives from OpenSim::Object. 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

OpenSim::ControlConstant::ControlConstant	(	double	aX = `0.0`,
		const char *	aName = `"UNKOWN"`
	)

Parameters

aX	Constant value of the control.
aName	Name of the control.

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

virtual OpenSim::ControlConstant::~ControlConstant ( )

virtual

Member Function Documentation

virtual double OpenSim::ControlConstant::getControlValue ( double aT)

virtual

Parameters

aT	Not used since the control value is constant in time.

Implements OpenSim::Control.

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

virtual

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

Parameters

aT	Time 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 determin the value of the control curve. Otherwise, the value of either the first control node or last control node is returned.

Implements OpenSim::Control.

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

virtual

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

Parameters

aT	Time 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 determin the value of the control curve. Otherwise, the value of either the first control node or last control node is returned.

Implements OpenSim::Control.

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

virtual

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

Implements OpenSim::Control.

virtual int OpenSim::ControlConstant::getParameterList	(	double	aT,
		Array< int > &	rList
	)

virtual

Parameters

aT	time
rList	Parameter at index 0 (i.e., the value of the constant) is the only parameter on the list.

Implements OpenSim::Control.

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

virtual

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

aTLower	Lower time bound.
aTUpper	Upper time bound.
rList	List 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.

virtual double OpenSim::ControlConstant::getParameterMax ( int aI) const

virtual

See Also: setParameterMax()

Parameters

aI	Index of the parameter.

Exceptions

Exception if aI is invalid.

Implements OpenSim::Control.

virtual double OpenSim::ControlConstant::getParameterMin ( int aI) const

virtual

See Also: setParameterMin()

Parameters

aI	Index of the parameter for which the minimum value is desired.

Exceptions

Exception if aI is invalid.

Implements OpenSim::Control.

virtual void OpenSim::ControlConstant::getParameterNeighborhood	(	int	aI,
		double &	rTLower,
		double &	rTUpper
	)		const

virtual

Parameters

aI	Index of the parameter.
rTLower	-SimTK::Infinity
rTUpper	SimTK::Infinity

Implements OpenSim::Control.

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

virtual

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

Parameters

aI	Index of the parameter.

Returns: SimTK::NaN

Implements OpenSim::Control.

virtual double OpenSim::ControlConstant::getParameterValue ( int aI) const

virtual

See Also: setParameterValue()

Parameters

aI	Only 0 is valid for ControlConstant.

Returns: The constant value of this control curve.

Implements OpenSim::Control.

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

virtual void OpenSim::ControlConstant::setControlValue	(	double	aT,
		double	aX
	)

virtual

Parameters

aT	Not used since the control value is constant in time.
aX	Control value.

Implements OpenSim::Control.

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

virtual

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

Parameters

aT	Time at which to set the control.
aMax	Maximum allowed control value.

Implements OpenSim::Control.

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

virtual

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

Parameters

aT	Time at which to set the control.
aMin	Minimum allowed control value at time aT.

Implements OpenSim::Control.

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

virtual

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

Parameters

aI	Index of the parameter.
aMax	Maximum value the parameter can have.

Exceptions

Exception if aI is invalid.

Implements OpenSim::Control.

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

virtual

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

Parameters

aI	Index of the parameter.
aMin	Minimum value the parameter can have.

Exceptions

Exception if aI is invalid.

Implements OpenSim::Control.

virtual void OpenSim::ControlConstant::setParameterValue	(	int	aI,
		double	aX
	)

virtual

Parameters

aI	Only 0 is valid for ControlConstant.
aX	The constant value of this control curve.

Implements OpenSim::Control.

void OpenSim::ControlConstant::setupProperties ( )

protectedvirtual

Reimplemented from OpenSim::Control.

Member Data Documentation

PropertyDbl OpenSim::ControlConstant::_propX

protected

Control value.

double& OpenSim::ControlConstant::_x

protected

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

/home/fitze/repos/opensim/Branches/OpenSim32ForDoxygen/OpenSim/Simulation/Control/ControlConstant.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation