Iface Class Reference

#include <gazebo.h>

Inheritance diagram for Iface:

ActarrayIface AudioIface CameraIface FactoryIface FiducialIface Graphics3dIface GripperIface LaserIface PositionIface PTZIface SimulationIface StereoCameraIface List of all members.

Detailed Description

Base class for all interfaces.

Public Member Functions

 Iface (const std::string &type, size_t size)
 Create an interface.
virtual ~Iface ()
 Destroy an interface.
virtual void Create (Server *server, std::string id)
 Create the interface (used by Gazebo server).
void Create (Server *server, std::string id, const std::string &modelType, int modelId, int parentModelId)
 Create the interface (used by Gazebo server).
void Destroy ()
 Destroy the interface (server).
virtual void Open (Client *client, std::string id)
 Open an existing interface.
virtual void Close ()
 Close the interface.
int Lock (int blocking)
 Lock the interface.
int Unlock ()
 Unlock the interface.
void Post ()
 Tell clients that new data is available.
int GetOpenCount ()
 Get the number of connections.
std::string GetType () const
 Get the iface type.

Public Attributes

 The server we are associated with.
 The client we are associated with.
int mmapFd
 File descriptor for the mmap file.
void * mMap
 Pointer to the mmap'ed mem.
std::string filename
 The name of the file we created/opened.

Protected Attributes

std::string type
 type of interface

Constructor & Destructor Documentation

Iface ( const std::string &  type,
size_t  size 

Create an interface.

type Type of interface
size Size of the interface in bytes

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

Last updated Aug 04 2007