Gazebo

User
Frontpage
Installation
Worldfile Syntax
GUI
Media Resources
Tutorials
Model Creation
Sensor Creation
Controller Creation
Using Player
Using Terrains
Creating Custom Meshes
API
Code Reference
Class List
Class Hierarchy
gazebo::Controller

Controller Class Reference
[Controller]

#include <Controller.hh>

Inheritance diagram for Controller:

AudioController Bandit_Actarray ControllerStub Differential_Position2d Factory Generic_Camera Generic_PTZ Pioneer2_Gripper SickLMS200_Laser Steering_Position2d Stereo_Camera List of all members.

Detailed Description

Base class for all controllers.


Public Member Functions

 Controller (Entity *parent)
 Constructor.
virtual ~Controller ()
 Destructor.
void Load (XMLConfigNode *node)
 Load the controller.
void Save ()
 Save the controller.
void Init ()
 Initialize the controller.
void Reset ()
 Reset the controller.
void Update (UpdateParams &params)
 Update the controller.
void Fini ()
 Finialize the controller. Called once on completion.
std::string GetName () const
 Return the name of this controller.

Protected Member Functions

virtual void LoadChild (XMLConfigNode *)
 Load function for the child class.
virtual void SaveChild (XMLConfigNode *)
 Save function for the child class.
virtual void InitChild ()
 Init function for the child class.
virtual void ResetChild ()
 Reset function for the child class.
virtual void UpdateChild (UpdateParams &)
 Update function for the child class.
virtual void FiniChild ()
 Fini function for the child class.

Protected Attributes

std::string name
 The controller's name.
Entity * parent
 The entity that owns this controller.
double updatePeriod
 Update period.
double lastUpdate
 Last update time.
std::vector< Iface * > ifaces
 Array of all the iface for this controller.
XMLConfigNode * xmlNode

Constructor & Destructor Documentation

Controller ( Entity *  parent  ) 

Constructor.

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

Member Function Documentation

void Load ( XMLConfigNode *  node  ) 

Load the controller.

Called once on startup

Parameters:
node The XMLConfig node pointer

void Save (  ) 

Save the controller.

Parameters:
node The XMLConfigWriter node pointer

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

std::string GetName (  )  const

Return the name of this controller.

Returns:
The name of the controller

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