Controller is an abstract ModelComponent that defines the interface for an OpenSim Controller. More...

#include <Controller.h>

Inheritance diagram for OpenSim::Controller:

Property declarations
These are the serializable properties associated with a Controller.
int	_numControls
	number of controls this controller computes
class	ControllerSet
	OpenSim_DECLARE_PROPERTY (isDisabled, bool,"Flag (true or false) indicating whether or not the controller is disabled.")
	OpenSim_DECLARE_LIST_PROPERTY (actuator_list, std::string,"The list of model actuators that this controller will control.""The keyword ALL indicates the controller will controll all the acuators in the model")
	Controller ()
	Default constructor.
bool	isDisabled () const
	Get whether or not this controller is disabled.
void	setDisabled (bool disableFlag)
	Disable this controller.
virtual void	computeControls (const SimTK::State &s, SimTK::Vector &controls) const =0
	Compute the control for actuator This method defines the behavior for any concrete controller and therefore must be implemented by concrete subclasses.
void	setActuators (const Set< Actuator > &actuators)
	replace the current set of actuators with the provided set
void	addActuator (const Actuator &actuator)
	add to the current set of actuators
const Set< Actuator > &	getActuatorSet () const
	get a const reference to the current set of actuators
Set< Actuator > &	updActuators ()
	get a writable reference to the set of actuators for this controller
void	connectToModel (Model &model) override
	Model component interface that permits the controller to be "wired" up to its actuators.
void	addToSystem (SimTK::MultibodySystem &system) const override
	Model component interface that creates underlying computational components in the SimTK::MultibodySystem.

Additional Inherited Members
Public Member Functions inherited from OpenSim::ModelComponent
	ModelComponent ()
	Default constructor.
	ModelComponent (const std::string &aFileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
	Construct ModelComponent from an XML file.
	ModelComponent (SimTK::Xml::Element &aNode)
	Construct ModelComponent from a specific node in an XML document.
	ModelComponent (const ModelComponent &source)
	Construct ModelComponent with its contents copied from another ModelComponent; this is a deep copy so nothing is shared with the source after the copy.
virtual	~ModelComponent ()
	Destructor is virtual to allow concrete model component cleanup.
ModelComponent &	operator= (const ModelComponent &aModelComponent)
	Assignment operator to copy contents of an existing component.
const Model &	getModel () const
	Get a const reference to the Model this component is part of.
Model &	updModel ()
	Get a modifiable reference to the Model this component is part of.
virtual void	updateDisplayer (const SimTK::State &s)
	In case the ModelComponent has a visual representation (VisualObject), override this method to update it.
virtual int	getNumStateVariables () const
	Get the number of "Continuous" state variables maintained by the ModelComponent and its specified subcomponents.
virtual Array< std::string >	getStateVariableNames () const
	Get the names of "continuous" state variables maintained by the ModelComponent and its subcomponents.
virtual SimTK::SystemYIndex	getStateVariableSystemIndex (const std::string &stateVariableName) const
	Get the System Index of a state variable allocated by this ModelComponent.
int	getModelingOption (const SimTK::State &state, const std::string &name) const
	Get a ModelingOption flag for this ModelComponent by name.
void	setModelingOption (SimTK::State &state, const std::string &name, int flag) const
	Set the value of a ModelingOption flag for this ModelComponent.
double	getStateVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a state variable allocated by this ModelComponent.
void	setStateVariable (SimTK::State &state, const std::string &name, double value) const
	Set the value of a state variable allocated by this ModelComponent by name.
double	getDiscreteVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a discrete variable allocated by this ModelComponent by name.
void	setDiscreteVariable (SimTK::State &state, const std::string &name, double value) const
	Set the value of a discrete variable allocated by this ModelComponent by name.
template<typename T >
const T &	getCacheVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a cache variable allocated by this ModelComponent by name.
template<typename T >
T &	updCacheVariable (const SimTK::State &state, const std::string &name) const
	Obtain a writable cache variable value allocated by this ModelComponent by name.
void	markCacheVariableValid (const SimTK::State &state, const std::string &name) const
	After updating a cache variable value allocated by this ModelComponent, you can mark its value as valid, which will not change until the realization stage falls below the minimum set at the time the cache variable was created.
void	markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const
	Mark a cache variable value allocated by this ModelComponent as invalid.
bool	isCacheVariableValid (const SimTK::State &state, const std::string &name) const
	Enables the to monitor the validity of the cache variable value using the returned flag.
template<typename T >
void	setCacheVariable (const SimTK::State &state, const std::string &name, T &value) const
	Set cache variable value allocated by this ModelComponent by name.
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.
static void	renameType (const std::string &oldTypeName, const std::string &newTypeName)
	Support versioning by associating the current %Object type with an old name.
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.
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*.
static Object *	newInstanceOfType (const std::string &concreteClassName)
	Create a new instance of the concrete %Object type whose class name is given as concreteClassName.
static void	getRegisteredTypenames (Array< std::string > &typeNames)
	Retrieve all the typenames registered so far.
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.
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.
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.
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.
static const std::string &	getClassName ()
	Return the name of this class as a string; i.e., "Object".
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.
static bool	getSerializeAllDefaults ()
	Report the value of the "serialize all defaults" flag.
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.
static void	setDebugLevel (int newLevel)
	Set the debug level to get verbose output.
static int	getDebugLevel ()
	Get current setting of debug level.
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.
static void	RegisterType (const Object &defaultObject)
	OBSOLETE alternate name for registerType().
static void	RenameType (const std::string &oldName, const std::string &newName)
	OBSOLETE alternate name for renameType().
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::ModelComponent
virtual void	initStateFromProperties (SimTK::State &state) const
	Transfer property values or other state-independent initial values into this component's state variables in the passed-in state argument.
virtual void	setPropertiesFromState (const SimTK::State &state)
	Update this component's property values to match the specified State, if the component has created any state variable that is intended to correspond to a property.
virtual SimTK::Vector	computeStateVariableDerivatives (const SimTK::State &s) const
	If a model component has allocated any continuous state variables using the addStateVariable() method, then computeStateVariableDerivatives() must be implemented to provide time derivatives for those states.
virtual void	generateDecorations (bool fixed, const ModelDisplayHints &hints, const SimTK::State &state, SimTK::Array_< SimTK::DecorativeGeometry > &appendToThis) const
	Optional method for generating arbitrary display geometry that reflects this ModelComponent at the specified state.
void	includeAsSubComponent (ModelComponent *aComponent)
	Include another ModelComponent as a Subcomponent of this ModelComponent.
void	addModelingOption (const std::string &optionName, int maxFlagValue) const
	Add a modeling option (integer flag stored in the State) for use by this ModelComponent.
void	addStateVariable (const std::string &stateVariableName, SimTK::Stage invalidatesStage=SimTK::Stage::Dynamics) const
	Add a continuous system state variable belonging to this ModelComponent, and assign a name by which to refer to it.
void	addDiscreteVariable (const std::string &discreteVariableName, SimTK::Stage invalidatesStage) const
	Add a system discrete variable belonging to this ModelComponent, give it a name by which it can be referenced, and declare the lowest Stage that should be invalidated if this variable's value is changed.
template<class T >
void	addCacheVariable (const std::string &cacheVariableName, const T &variablePrototype, SimTK::Stage dependsOnStage) const
	Add a state cache entry belonging to this ModelComponent to hold calculated values that must be automatically invalidated when certain state values change.
const int	getStateIndex (const std::string &name) const
	Get the index of a ModelComponent's continuous state variable in the Subsystem for allocations.
const SimTK::DiscreteVariableIndex	getDiscreteVariableIndex (const std::string &name) const
	Get the index of a ModelComponent's discrete variable in the Subsystem for allocations.
const SimTK::CacheEntryIndex	getCacheVariableIndex (const std::string &name) const
	Get the index of a ModelComponent's cache variable in the Subsystem for allocations.
Protected Attributes inherited from OpenSim::ModelComponent
Model *	_model
	The model this component belongs to.
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.
#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.
#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>.
#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.

Detailed Description

Controller is an abstract ModelComponent that defines the interface for an OpenSim Controller.

A controller computes and sets the values of the controls for the actuators under its control. The defining method of a Controller is its computeControls() method.

See Also: computeControls()

Author: Ajay Seth

Constructor & Destructor Documentation

OpenSim::Controller::Controller ( )

Default constructor.

Member Function Documentation

void OpenSim::Controller::addActuator ( const Actuator & actuator )

add to the current set of actuators

void OpenSim::Controller::addToSystem ( SimTK::MultibodySystem & system ) const

overrideprotectedvirtual

Model component interface that creates underlying computational components in the SimTK::MultibodySystem.

This includes adding states, creating measures, etc... required by the controller.

Reimplemented from OpenSim::ModelComponent.

Reimplemented in OpenSim::CMC, OpenSim::CorrectionController, and OpenSim::ControlSetController.

virtual void OpenSim::Controller::computeControls	(	const SimTK::State &	s,
		SimTK::Vector &	controls
	)		const

pure virtual

Compute the control for actuator This method defines the behavior for any concrete controller and therefore must be implemented by concrete subclasses.

Parameters

s	system state
controls	writable model controls (all actuators)

Implemented in OpenSim::CMC, OpenSim::TrackingController, OpenSim::PrescribedController, OpenSim::ControlSetController, and OpenSim::CorrectionController.

void OpenSim::Controller::connectToModel ( Model & model )

overrideprotectedvirtual

Model component interface that permits the controller to be "wired" up to its actuators.

Subclasses can override to perform additional setup.

Reimplemented from OpenSim::ModelComponent.

Reimplemented in OpenSim::CMC, OpenSim::CorrectionController, and OpenSim::ControlSetController.

const Set<Actuator>& OpenSim::Controller::getActuatorSet ( ) const

get a const reference to the current set of actuators

bool OpenSim::Controller::isDisabled ( ) const

Get whether or not this controller is disabled.

Returns: true when controller is disabled.

OpenSim::Controller::OpenSim_DECLARE_LIST_PROPERTY	(	actuator_list	,
		std::string	,
		"The list of model actuators that this controller will control.""The keyword ALL indicates the controller will controll all the acuators in the model"
	)

OpenSim::Controller::OpenSim_DECLARE_PROPERTY	(	isDisabled	,
		bool	,
		"Flag (true or false) indicating whether or not the controller is disabled."
	)

void OpenSim::Controller::setActuators ( const Set< Actuator > & actuators )

replace the current set of actuators with the provided set

void OpenSim::Controller::setDisabled ( bool disableFlag )

Disable this controller.

Parameters

disableFlag Disable if true.

Set<Actuator>& OpenSim::Controller::updActuators ( )

get a writable reference to the set of actuators for this controller

Friends And Related Function Documentation

friend class ControllerSet

friend

Member Data Documentation

int OpenSim::Controller::_numControls

number of controls this controller computes

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

E:/Projects/OpenSim30Br/OpenSim30/OpenSim/Simulation/Control/Controller.h

Property declarations

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation