RobWorkProject
Public Types | Public Member Functions | List of all members
ControllerModel Class Reference

Interface to allow modelling of different types of controllers. A controller is an instance that takes an input manipulates it to an output that in effect controls something. As such controllers vary greatly and have only little in common. More...

#include <ControllerModel.hpp>

Inherits Stateless.

Public Types

typedef rw::common::Ptr< ControllerModelPtr
 smart pointer type
 
- Public Types inherited from Stateless
typedef rw::common::Ptr< StatelessPtr
 Smart pointer type for Stateless.
 

Public Member Functions

 ControllerModel (const std::string &name, kinematics::Frame *frame)
 constructor More...
 
 ControllerModel (const std::string &name, kinematics::Frame *frame, const std::string &description)
 constructor More...
 
virtual ~ControllerModel ()
 destructor
 
void setName (const std::string &name)
 sets the name of this controllermodel More...
 
void setDescription (const std::string &description)
 sets the description of this controllermodel More...
 
const std::string & getName () const
 returns the name of this controllermodel More...
 
const std::string & getDescription () const
 returns a description of this controllermodel More...
 
kinematics::FramegetFrame () const
 The frame to which the controllermodel is attached. More...
 
virtual void attachTo (kinematics::Frame *frame)
 Sets the frame to which the controllermodel should be attached. More...
 
rw::common::PropertyMapgetPropertyMap ()
 gets the propertymap of this controllermodel
 
const rw::common::PropertyMapgetPropertyMap () const
 gets the propertymap of this controllermodel
 
- Public Member Functions inherited from Stateless
virtual ~Stateless ()
 destructor
 
virtual void registerIn (State &state)
 initialize this stateless data to a specific state More...
 
virtual void registerIn (StateStructure::Ptr state)
 register this stateless object in a statestructure.
 
virtual void unregister ()
 unregisters all state data of this stateless object
 
StateStructure::Ptr getStateStructure ()
 Get the state structure. More...
 
const StateStructure::Ptr getStateStructure () const
 Get the state structure. More...
 
bool isRegistered ()
 Check if object has registered its state. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Stateless
 Stateless ()
 constructor
 
template<class T >
void add (StatelessData< T > &data)
 implementations of sensor should add all their stateless data on initialization
 
void add (StateData *data)
 Add data. More...
 
void add (boost::shared_ptr< StateData > data)
 implementations of sensor should add all their state data on initialization
 
- Protected Attributes inherited from Stateless
bool _registered
 True if object has registered its state.
 
std::vector< boost::shared_ptr< StateData > > _datas
 Data.
 
StateStructure::Ptr _stateStruct
 The state structure.
 

Detailed Description

Interface to allow modelling of different types of controllers. A controller is an instance that takes an input manipulates it to an output that in effect controls something. As such controllers vary greatly and have only little in common.

Constructor & Destructor Documentation

◆ ControllerModel() [1/2]

ControllerModel ( const std::string &  name,
kinematics::Frame frame 
)

constructor

Parameters
name[in] the name of this controllermodel
frame[in] the frame to which this controller is attached/associated.

◆ ControllerModel() [2/2]

ControllerModel ( const std::string &  name,
kinematics::Frame frame,
const std::string &  description 
)

constructor

Parameters
name[in] the name of this controllermodel
frame[in] the frame to which this controller is attached/associated.
description[in] description of the controller

Member Function Documentation

◆ attachTo()

virtual void attachTo ( kinematics::Frame frame)
inlinevirtual

Sets the frame to which the controllermodel should be attached.

Parameters
frameThe frame, which can be NULL

◆ getDescription()

const std::string& getDescription ( ) const
inline

returns a description of this controllermodel

Returns
reference to this controllermodels description

◆ getFrame()

kinematics::Frame* getFrame ( ) const
inline

The frame to which the controllermodel is attached.

The frame can be NULL.

◆ getName()

const std::string& getName ( ) const
inline

returns the name of this controllermodel

Returns
name of controllermodel

◆ setDescription()

void setDescription ( const std::string &  description)
inline

sets the description of this controllermodel

Parameters
description[in] description of this controllermodel

◆ setName()

void setName ( const std::string &  name)
inline

sets the name of this controllermodel

Parameters
name[in] name of this controllermodel

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