Gazebo logo

position
[libgazebo]


Classes

struct  gz_position_data
 Position interface. More...
struct  gz_position
 The position interface. More...

Typedefs

typedef gz_position_data gz_position_data_t
 Position interface.
typedef gz_position gz_position_t
 The position interface.

Functions

gz_position_tgz_position_alloc ()
 Create an interface.
void gz_position_free (gz_position_t *self)
 Destroy an interface.
int gz_position_create (gz_position_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_position_destroy (gz_position_t *self)
int gz_position_open (gz_position_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_position_close (gz_position_t *self)
 Close the interface (client).
int gz_position_lock (gz_position_t *self, int blocking)
void gz_position_unlock (gz_position_t *self)
 Unlock the interface.
int gz_position_post (gz_position_t *self)
 Tell clients that new data is available.

Detailed Description

The position interface allows clients to send commands to and read odometric data from simulated mobile robot bases, such as the Pioneer2AT or ATRV Jr. This interface handles both 2D and 3D data.

Typedef Documentation

typedef struct gz_position_data gz_position_data_t
 

Position interface.

typedef struct gz_position gz_position_t
 

The position interface.


Function Documentation

gz_position_t* gz_position_alloc  ) 
 

Create an interface.

void gz_position_free gz_position_t self  ) 
 

Destroy an interface.

int gz_position_create gz_position_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_position_destroy gz_position_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_position_open gz_position_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_position_close gz_position_t self  ) 
 

Close the interface (client).

int gz_position_lock gz_position_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_position_unlock gz_position_t self  ) 
 

Unlock the interface.

int gz_position_post gz_position_t self  ) 
 

Tell clients that new data is available.


Last updated 12 September 2005 21:38:45