GazeboInterface Class Reference
[Player]
#include <GazeboInterface.hh>
Inheritance diagram for GazeboInterface:
Detailed Description
Base class for all the player interfaces.
Public Member Functions | |
| GazeboInterface (player_devaddr_t addr, GazeboDriver *driver, ConfigFile *cf, int section) | |
| Constructor. | |
| virtual | ~GazeboInterface () |
| Destructor. | |
| virtual int | ProcessMessage (QueuePointer &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. | |
| virtual void | Unsubscribe ()=0 |
| Close a SHM interface. | |
Public Attributes | |
| player_devaddr_t | device_addr |
| Address of the Player Device. | |
| GazeboDriver * | driver |
| Driver instance that created this device. | |
Member Function Documentation
| 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, PTZInterface, 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, PTZInterface, and SimulationInterface.
The documentation for this class was generated from the following file: