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::GazeboInterface

GazeboInterface Class Reference
[Player]

#include <GazeboInterface.hh>

Inheritance diagram for GazeboInterface:

ActarrayInterface CameraInterface FiducialInterface Graphics3dInterface LaserInterface Position2dInterface Position3dInterface SimulationInterface

List of all members.

Detailed Description

Base class for all the player interfaces

Public Member Functions

 GazeboInterface (player_devaddr_t addr, GazeboDriver *driver, ConfigFile *cf, int section)
virtual ~GazeboInterface ()
virtual int ProcessMessage (QueuePointer &respQueue, player_msghdr_t *hdr, void *data)=0
virtual void Update ()=0
virtual void Subscribe ()=0
virtual void Unsubscribe ()=0

Public Attributes

player_devaddr_t device_addr
GazeboDriver * driver

Constructor & Destructor Documentation

GazeboInterface ( player_devaddr_t  addr,
GazeboDriver *  driver,
ConfigFile *  cf,
int  section 
)

Constructor

virtual ~GazeboInterface (  )  [virtual]

Destructor

Member Function Documentation

virtual int ProcessMessage ( QueuePointer &  respQueue,
player_msghdr_t *  hdr,
void *  data 
) [pure virtual]

Handle all messages. This is called from GazeboDriver

Implemented in ActarrayInterface, CameraInterface, FiducialInterface, Graphics3dInterface, LaserInterface, Position2dInterface, Position3dInterface, and SimulationInterface.

virtual void Update (  )  [pure virtual]

Update this interface, publish new info.

Implemented in ActarrayInterface, CameraInterface, FiducialInterface, Graphics3dInterface, LaserInterface, Position2dInterface, Position3dInterface, and SimulationInterface.

virtual void Subscribe (  )  [pure virtual]

Open a SHM interface when a subscription is received. This is called fromGazeboDriver::Subscribe

Implemented in ActarrayInterface, CameraInterface, FiducialInterface, Graphics3dInterface, LaserInterface, Position2dInterface, Position3dInterface, and SimulationInterface.

virtual void Unsubscribe (  )  [pure virtual]

Close a SHM interface. This is called from GazeboDriver::Unsubscribe

Implemented in ActarrayInterface, CameraInterface, FiducialInterface, Graphics3dInterface, LaserInterface, Position2dInterface, Position3dInterface, and SimulationInterface.

Member Data Documentation

player_devaddr_t device_addr

Address of the Player Device

GazeboDriver* driver

Driver instance that created this device

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