Gazebo logo

gps
[libgazebo]


Classes

struct  gz_gps_data
 GPS interface. More...
struct  gz_gps
 The GPS interface. More...

Typedefs

typedef gz_gps_data gz_gps_data_t
 GPS interface.
typedef gz_gps gz_gps_t
 The GPS interface.

Functions

gz_gps_tgz_gps_alloc ()
 Create an interface.
void gz_gps_free (gz_gps_t *self)
 Destroy an interface.
int gz_gps_create (gz_gps_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_gps_destroy (gz_gps_t *self)
int gz_gps_open (gz_gps_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_gps_close (gz_gps_t *self)
 Close the interface (client).
int gz_gps_lock (gz_gps_t *self, int blocking)
void gz_gps_unlock (gz_gps_t *self)
 Unlock the interface.
int gz_gps_post (gz_gps_t *self)
 Tell clients that new data is available.

Detailed Description

The gps interface allows the user to receive GPS (Latitude/Longitude/Altitude) information for the robot platform on which the GPS device is mounted.

Typedef Documentation

typedef struct gz_gps_data gz_gps_data_t
 

GPS interface.

typedef struct gz_gps gz_gps_t
 

The GPS interface.


Function Documentation

gz_gps_t* gz_gps_alloc  ) 
 

Create an interface.

void gz_gps_free gz_gps_t self  ) 
 

Destroy an interface.

int gz_gps_create gz_gps_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_gps_destroy gz_gps_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_gps_open gz_gps_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_gps_close gz_gps_t self  ) 
 

Close the interface (client).

int gz_gps_lock gz_gps_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_gps_unlock gz_gps_t self  ) 
 

Unlock the interface.

int gz_gps_post gz_gps_t self  ) 
 

Tell clients that new data is available.


Last updated 12 September 2005 21:38:45