AbstractControllerAdapter Class Reference

Abstract adapter class (interface) for robot controller. More...

#include <abstractcontrolleradapter.h>

Inherits AbstractController.

Inherited by AbstractMultiController, CrossMotorCoupling, DiscreteControllerAdapter, and MeasureAdapter.

Collaboration diagram for AbstractControllerAdapter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 AbstractControllerAdapter (AbstractController *controller, const std::string &name, const std::string &revision)
virtual ~AbstractControllerAdapter ()
virtual void init (int sensornumber, int motornumber, RandGen *randGen=0)
 initialisation of the controller with the given sensor/ motornumber Must NORMALLY be called before use.
virtual int getSensorNumber () const
virtual int getMotorNumber () const
virtual void step (const sensor *sensors, int sensornumber, motor *motors, int motornumber)
 performs one step (includes learning).
virtual void stepNoLearning (const sensor *sensors, int sensornumber, motor *motors, int motornumber)
 performs one step without learning.
virtual bool store (FILE *f) const
virtual bool restore (FILE *f)

Protected Attributes

AbstractControllercontroller

Detailed Description

Abstract adapter class (interface) for robot controller.

The controller gets a number of input sensor values each timestep and has to generate a number of output motor values.

Interface assumes the following usage:

With the adapter class you can easily overwrite e.g. init(), step().

This is an abstract adapter class, it's useful for implementing adapters such as the DescreteController, which can be used with all Controllers.

Note that the configureable and inspectable classes are registered at this adapter class.

The store and restore-functionality is lead through, thus only store() and restore() from


Constructor & Destructor Documentation

AbstractControllerAdapter ( AbstractController controller,
const std::string &  name,
const std::string &  revision 
) [inline]
virtual ~AbstractControllerAdapter (  )  [inline, virtual]

Member Function Documentation

virtual int getMotorNumber (  )  const [inline, virtual]
Returns:
Number of motors the controller was initialised with or 0 if not initialised

Implements AbstractController.

virtual int getSensorNumber (  )  const [inline, virtual]
Returns:
Number of sensors the controller was initialised with or 0 if not initialised

Implements AbstractController.

virtual void init ( int  sensornumber,
int  motornumber,
RandGen randGen = 0 
) [inline, virtual]

initialisation of the controller with the given sensor/ motornumber Must NORMALLY be called before use.

For all ControllerAdapters call first AbstractControllerAdapter::init(sensornumber,motornumber) if you overwrite this method

Implements AbstractController.

Reimplemented in AbstractMultiController, DiscreteControllerAdapter, MeasureAdapter, and OneActiveMultiPassiveController.

virtual bool restore ( FILE *  f  )  [inline, virtual]
See also:
Storable

Implements Storeable.

Reimplemented in AbstractMultiController.

virtual void step ( const sensor sensors,
int  sensornumber,
motor motors,
int  motornumber 
) [inline, virtual]

performs one step (includes learning).

Calculates motor commands from sensor inputs.

Parameters:
sensors sensors inputs scaled to [-1,1]
sensornumber length of the sensor array
motors motors outputs. MUST have enough space for motor values!
motornumber length of the provided motor array

Implements AbstractController.

Reimplemented in AbstractMultiController, CrossMotorCoupling, DiscreteControllerAdapter, Discretesizable, MeasureAdapter, and OneActiveMultiPassiveController.

virtual void stepNoLearning ( const sensor sensors,
int  sensornumber,
motor motors,
int  motornumber 
) [inline, virtual]

performs one step without learning.

See also:
step

Implements AbstractController.

Reimplemented in AbstractMultiController, DiscreteControllerAdapter, Discretesizable, MeasureAdapter, and OneActiveMultiPassiveController.

virtual bool store ( FILE *  f  )  const [inline, virtual]
See also:
Storable

Implements Storeable.

Reimplemented in AbstractMultiController.


Member Data Documentation


The documentation for this class was generated from the following file:
Generated on Thu Jun 28 14:48:05 2012 for Robot Simulator of the Robotics Group for Self-Organization of Control by  doxygen 1.6.3