Gazebo logo

GazeboInterface Class Reference

#include <GazeboInterface.hh>

Inheritance diagram for GazeboInterface:

CameraInterface FiducialInterface GripperInterface LaserInterface Position2dInterface Position3dInterface PowerInterface PtzInterface SimulationInterface SonarInterface TruthInterface List of all members.

Public Member Functions

 GazeboInterface (player_devaddr_t addr, GazeboDriver *driver, ConfigFile *cf, int section)
 Constructor.
virtual ~GazeboInterface ()
 Destructor.
virtual int ProcessMessage (MessageQueue *respQueue, player_msghdr_t *hdr, void *data)=0
 Handle all messages. This is called from GazeboDriver.
virtual void Update ()=0
 Update this interface, publish new info.
virtual void Subscribe ()=0
 Open a SHM interface when a subscription is received. \ This is called fromGazeboDriver::Subscribe.
virtual void Unsubscribe ()=0
 Close a SHM interface. This is called from \ GazeboDriver::Unsubscribe.

Public Attributes

player_devaddr_t device_addr
 Address of the Player Device.
GazeboDriverdriver
 Driver instance that created this device.

Constructor & Destructor Documentation

GazeboInterface::GazeboInterface player_devaddr_t  addr,
GazeboDriver driver,
ConfigFile *  cf,
int  section
 

Constructor.

GazeboInterface::~GazeboInterface  )  [virtual]
 

Destructor.


Member Function Documentation

virtual int GazeboInterface::ProcessMessage MessageQueue *  respQueue,
player_msghdr_t *  hdr,
void *  data
[pure virtual]
 

Handle all messages. This is called from GazeboDriver.

Implemented in CameraInterface, FiducialInterface, GripperInterface, LaserInterface, Position2dInterface, Position3dInterface, PowerInterface, PtzInterface, SimulationInterface, SonarInterface, and TruthInterface.

virtual void GazeboInterface::Update  )  [pure virtual]
 

Update this interface, publish new info.

Implemented in CameraInterface, FiducialInterface, GripperInterface, LaserInterface, Position2dInterface, Position3dInterface, PowerInterface, PtzInterface, SimulationInterface, SonarInterface, and TruthInterface.

virtual void GazeboInterface::Subscribe  )  [pure virtual]
 

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

Implemented in CameraInterface, FiducialInterface, GripperInterface, LaserInterface, Position2dInterface, Position3dInterface, PowerInterface, PtzInterface, SimulationInterface, SonarInterface, and TruthInterface.

virtual void GazeboInterface::Unsubscribe  )  [pure virtual]
 

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

Implemented in CameraInterface, FiducialInterface, GripperInterface, LaserInterface, Position2dInterface, Position3dInterface, PowerInterface, PtzInterface, SimulationInterface, SonarInterface, and TruthInterface.


Member Data Documentation

player_devaddr_t GazeboInterface::device_addr
 

Address of the Player Device.

GazeboDriver* GazeboInterface::driver
 

Driver instance that created this device.


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

Last updated 12 September 2005 21:38:45