Gazebo logo

truth
[libgazebo]


Classes

struct  gz_truth_data
 Truth data. More...
struct  gz_truth
 The truth interface. More...

Typedefs

typedef gz_truth_data gz_truth_data_t
 Truth data.
typedef gz_truth gz_truth_t
 The truth interface.

Functions

gz_truth_tgz_truth_alloc ()
 Create an interface.
void gz_truth_free (gz_truth_t *self)
 Destroy an interface.
int gz_truth_create (gz_truth_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_truth_destroy (gz_truth_t *self)
int gz_truth_open (gz_truth_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_truth_close (gz_truth_t *self)
 Close the interface (client).
int gz_truth_lock (gz_truth_t *self, int blocking)
void gz_truth_unlock (gz_truth_t *self)
 Unlock the interface.
int gz_truth_post (gz_truth_t *self)
 Tell clients that new data is available.
void gz_truth_euler_from_quatern (gz_truth_t *self, double *e, double *q)
 Convenience function that converts to Euler(roll,pitch,yaw) from quatern.
void gz_truth_quatern_from_euler (gz_truth_t *self, double *q, double *e)
 Convenience function that converts to quatern from Euler(roll,pitch,yaw).

Detailed Description

The truth interface is useful for getting and setting the ground-truth pose of objects in the world; currently, it is supported only by the TruthWidget model.

Typedef Documentation

typedef struct gz_truth_data gz_truth_data_t
 

Truth data.

typedef struct gz_truth gz_truth_t
 

The truth interface.


Function Documentation

gz_truth_t* gz_truth_alloc  ) 
 

Create an interface.

void gz_truth_free gz_truth_t self  ) 
 

Destroy an interface.

int gz_truth_create gz_truth_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_truth_destroy gz_truth_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_truth_open gz_truth_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_truth_close gz_truth_t self  ) 
 

Close the interface (client).

int gz_truth_lock gz_truth_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_truth_unlock gz_truth_t self  ) 
 

Unlock the interface.

int gz_truth_post gz_truth_t self  ) 
 

Tell clients that new data is available.

void gz_truth_euler_from_quatern gz_truth_t self,
double *  e,
double *  q
 

Convenience function that converts to Euler(roll,pitch,yaw) from quatern.

void gz_truth_quatern_from_euler gz_truth_t self,
double *  q,
double *  e
 

Convenience function that converts to quatern from Euler(roll,pitch,yaw).


Last updated 12 September 2005 21:38:45