Gazebo

User
Frontpage
Installation
Worldfile Syntax
GUI
Code Reference
Class List
Class Hierarchy
Tutorials
Model Creation
Sensor Creation
Controller Creation
Using Player
Using Terrains
gazebo::Controller

Controller Class Reference
[Controller]

#include <Controller.hh>

Inheritance diagram for Controller:

Bandit_Actarray ControllerStub Factory Generic_Camera Pioneer2_Gripper Pioneer2dx_Position2d SickLMS200_Laser

List of all members.

Detailed Description

Base class for all controllers

Public Member Functions

 Controller (Entity *parent)
virtual ~Controller ()
void Load (XMLConfigNode *node)
void Init ()
void Update (UpdateParams &params)
void Fini ()
std::string GetName () const

Protected Member Functions

virtual void LoadChild (XMLConfigNode *)
virtual void InitChild ()
virtual void UpdateChild (UpdateParams &)
virtual void FiniChild ()

Protected Attributes

std::string name
Entity * parent
double updatePeriod
std::vector< Iface * > ifaces

Constructor & Destructor Documentation

Controller ( Entity *  parent  ) 

Constructor

Parameters:
parent The parent entity, must be a Model or a Sensor

virtual ~Controller (  )  [virtual]

Destructor

Member Function Documentation

void Load ( XMLConfigNode *  node  ) 

Load the controller. Called once on startup

Parameters:
node The XMLConfig node pointer
Returns:
0 on success

void Init (  ) 

Initialize the controller. Called once on startup.

Returns:
0 on success

void Update ( UpdateParams &  params  ) 

Update the controller. Called every cycle.

Parameters:
params Parameters to the update cycle
Returns:
0 on success

void Fini (  ) 

Finialize the controller. Called once on completion.

Returns:
0 on success

virtual void LoadChild ( XMLConfigNode *   )  [inline, protected, virtual]

Load function for the child class

Returns:
0 on success

Reimplemented in Bandit_Actarray, Generic_Camera, ControllerStub, Factory, Pioneer2_Gripper, SickLMS200_Laser, and Pioneer2dx_Position2d.

virtual void InitChild (  )  [inline, protected, virtual]

Init function for the child class

Returns:
0 on success

Reimplemented in Bandit_Actarray, Generic_Camera, ControllerStub, Factory, Pioneer2_Gripper, SickLMS200_Laser, and Pioneer2dx_Position2d.

virtual void UpdateChild ( UpdateParams &   )  [inline, protected, virtual]

Update function for the child class

Returns:
0 on success

Reimplemented in Bandit_Actarray, Generic_Camera, ControllerStub, Factory, Pioneer2_Gripper, SickLMS200_Laser, and Pioneer2dx_Position2d.

virtual void FiniChild (  )  [inline, protected, virtual]

Fini function for the child class

Returns:
0 on success

Reimplemented in Bandit_Actarray, Generic_Camera, ControllerStub, Factory, Pioneer2_Gripper, SickLMS200_Laser, and Pioneer2dx_Position2d.

std::string GetName (  )  const

Return the name of this controller

Returns:
The name of the controller

Member Data Documentation

std::string name [protected]

The controller's name

Entity* parent [protected]

The entity that owns this controller

double updatePeriod [protected]

Update period

std::vector<Iface*> ifaces [protected]

Array of all the iface for this controller

The documentation for this class was generated from the following file:
Last updated Aug 04 2007