OpenSim  OpenSim 3.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::TrackingController Class Referenceabstract

#include <TrackingController.h>

Inheritance diagram for OpenSim::TrackingController:
OpenSim::Controller OpenSim::ModelComponent OpenSim::Object OpenSim::CMC OpenSim::CorrectionController

Public Member Functions

 TrackingController ()
 Default constructor. More...
 
 TrackingController (const TrackingController &TrackingController)
 Copy constructor. More...
 
virtual ~TrackingController ()
 Destructor. More...
 
TrackingControlleroperator= (const TrackingController &TrackingController)
 Assignment operator. More...
 
virtual void setDesiredStatesStorage (const Storage *aYDesStore)
 Set this class's pointer to the storage object containing desired model states to point to the storage object passed into this method. More...
 
virtual const StoragegetDesiredStatesStorage () const
 
virtual void computeControls (const SimTK::State &s, SimTK::Vector &controls) const =0
 Controller interface. More...
 
- Public Member Functions inherited from OpenSim::Controller
 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. More...
 
bool isDisabled () const
 Get whether or not this controller is disabled. More...
 
void setDisabled (bool disableFlag)
 Disable this controller. More...
 
void setActuators (const Set< Actuator > &actuators)
 replace the current set of actuators with the provided set More...
 
void addActuator (const Actuator &actuator)
 add to the current set of actuators More...
 
const Set< Actuator > & getActuatorSet () const
 get a const reference to the current set of actuators More...
 
Set< Actuator > & updActuators ()
 get a writable reference to the set of actuators for this controller More...
 
int getNumControls () const
 

Protected Member Functions

virtual void setupProperties ()
 Connect properties to local pointers. More...
 
void copyData (const TrackingController &aController)
 Copy the member variables of the specified controller. More...
 
- Protected Member Functions inherited from OpenSim::Controller
void connectToModel (Model &model) override
 Model component interface that permits the controller to be "wired" up to its actuators. More...
 
void addToSystem (SimTK::MultibodySystem &system) const override
 Model component interface that creates underlying computational components in the SimTK::MultibodySystem. More...
 
void setNumControls (int numControls)
 Only a Controller can set its number of controls based on its actuators. More...
 

Protected Attributes

const Storage_desiredStatesStorage
 storage object containing the desired trajectory More...
 
Array< double > * _trackingTasks
 

Friends

class ControllerSet
 

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 ObjectgetDefaultInstanceOfType (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 ObjectnewInstanceOfType (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 ObjectmakeObjectFromFile (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 ObjectSafeCopy (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...
 

Constructor & Destructor Documentation

OpenSim::TrackingController::TrackingController ( )

Default constructor.

OpenSim::TrackingController::TrackingController ( const TrackingController TrackingController)

Copy constructor.

Parameters
TrackingControllerThe controller to be copied.
virtual OpenSim::TrackingController::~TrackingController ( )
virtual

Destructor.

This method should be a member of any subclass of the Controller class. It will be called automatically whenever an instance of the subclass is deleted from memory.

Member Function Documentation

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

Controller interface.

Implements OpenSim::Controller.

Implemented in OpenSim::CMC, and OpenSim::CorrectionController.

void OpenSim::TrackingController::copyData ( const TrackingController aController)
protected

Copy the member variables of the specified controller.

This method is called by the copy constructor of the Controller class.

Parameters
aControllerThe controller whose data is to be copied.
virtual const Storage& OpenSim::TrackingController::getDesiredStatesStorage ( ) const
virtual
TrackingController& OpenSim::TrackingController::operator= ( const TrackingController TrackingController)

Assignment operator.

Parameters
TrackingControllerThe controller to be copied.
Returns
Reference to the altered object.
virtual void OpenSim::TrackingController::setDesiredStatesStorage ( const Storage aYDesStore)
virtual

Set this class's pointer to the storage object containing desired model states to point to the storage object passed into this method.

This method is currently implemented only by the CorrectionController class, which is a subclass of Controller.

Parameters
aYDesStorePointer to a Storage object containing the desired states of the model for the controller to achieve during simulation.
virtual void OpenSim::TrackingController::setupProperties ( )
protectedvirtual

Connect properties to local pointers.

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

Friends And Related Function Documentation

friend class ControllerSet
friend

Member Data Documentation

const Storage* OpenSim::TrackingController::_desiredStatesStorage
protected

storage object containing the desired trajectory

Array<double>* OpenSim::TrackingController::_trackingTasks
protected

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