Gazebo logo

laser
[libgazebo]


Classes

struct  gz_laser_data
 Laser data. More...
struct  gz_laser
 The laser interface. More...

Defines

#define GZ_LASER_MAX_RANGES   401

Typedefs

typedef gz_laser_data gz_laser_data_t
 Laser data.
typedef gz_laser gz_laser_t
 The laser interface.

Functions

gz_laser_tgz_laser_alloc ()
 Create an interface.
void gz_laser_free (gz_laser_t *self)
 Destroy an interface.
int gz_laser_create (gz_laser_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_laser_destroy (gz_laser_t *self)
int gz_laser_open (gz_laser_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_laser_close (gz_laser_t *self)
 Close the interface (client).
int gz_laser_lock (gz_laser_t *self, int blocking)
void gz_laser_unlock (gz_laser_t *self)
 Unlock the interface.
int gz_laser_post (gz_laser_t *self)
 Tell clients that new data is available.

Detailed Description

The laser interface allows clients to read data from a simulated laser range finder (such as the SICK LMS200). Some configuration of this device is also allowed.

Define Documentation

#define GZ_LASER_MAX_RANGES   401
 


Typedef Documentation

typedef struct gz_laser_data gz_laser_data_t
 

Laser data.

typedef struct gz_laser gz_laser_t
 

The laser interface.


Function Documentation

gz_laser_t* gz_laser_alloc  ) 
 

Create an interface.

void gz_laser_free gz_laser_t self  ) 
 

Destroy an interface.

int gz_laser_create gz_laser_t self,
gz_server_t server,
const char *  id,
const char *  model_type,
int  model_id,
int  parent_model_id
 

For internal use only.

Create the interface (used by Gazebo server)

int gz_laser_destroy gz_laser_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_laser_open gz_laser_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_laser_close gz_laser_t self  ) 
 

Close the interface (client).

int gz_laser_lock gz_laser_t self,
int  blocking
 

Lock the interface. Set blocking to 1 if the caller should block until the lock is acquired. Returns 0 if the lock is acquired.

void gz_laser_unlock gz_laser_t self  ) 
 

Unlock the interface.

int gz_laser_post gz_laser_t self  ) 
 

Tell clients that new data is available.


Last updated 12 September 2005 21:38:45