Gazebo logo

sonar
[libgazebo]


Classes

struct  gz_sonar_data
 Sonar data interface. More...
struct  gz_sonar
 The sonar interface. More...

Defines

#define GZ_SONAR_MAX_RANGES   48

Typedefs

typedef gz_sonar_data gz_sonar_data_t
 Sonar data interface.
typedef gz_sonar gz_sonar_t
 The sonar interface.

Functions

gz_sonar_tgz_sonar_alloc ()
 Create an interface.
void gz_sonar_free (gz_sonar_t *self)
 Destroy an interface.
int gz_sonar_create (gz_sonar_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_sonar_destroy (gz_sonar_t *self)
int gz_sonar_open (gz_sonar_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_sonar_close (gz_sonar_t *self)
 Close the interface (client).
int gz_sonar_lock (gz_sonar_t *self, int blocking)
void gz_sonar_unlock (gz_sonar_t *self)
 Unlock the interface.

Detailed Description

The sonar interface allows the positions and range values for sonars to be read.

Define Documentation

#define GZ_SONAR_MAX_RANGES   48
 


Typedef Documentation

typedef struct gz_sonar_data gz_sonar_data_t
 

Sonar data interface.

typedef struct gz_sonar gz_sonar_t
 

The sonar interface.


Function Documentation

gz_sonar_t* gz_sonar_alloc  ) 
 

Create an interface.

void gz_sonar_free gz_sonar_t self  ) 
 

Destroy an interface.

int gz_sonar_create gz_sonar_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_sonar_destroy gz_sonar_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_sonar_open gz_sonar_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_sonar_close gz_sonar_t self  ) 
 

Close the interface (client).

int gz_sonar_lock gz_sonar_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_sonar_unlock gz_sonar_t self  ) 
 

Unlock the interface.


Last updated 12 September 2005 21:38:45