Gazebo logo

power
[libgazebo]


Classes

struct  gz_power_data
 Power interface. More...
struct  gz_power
 The power interface. More...

Typedefs

typedef gz_power_data gz_power_data_t
 Power interface.
typedef gz_power gz_power_t
 The power interface.

Functions

gz_power_tgz_power_alloc ()
 Create an interface.
void gz_power_free (gz_power_t *self)
 Destroy an interface.
int gz_power_create (gz_power_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_power_destroy (gz_power_t *self)
int gz_power_open (gz_power_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_power_close (gz_power_t *self)
 Close the interface (client).
int gz_power_lock (gz_power_t *self, int blocking)
void gz_power_unlock (gz_power_t *self)
 Unlock the interface.
int gz_power_post (gz_power_t *self)
 Tell clients that new data is available.

Detailed Description

The power interface allows clients to read battery levels from simulated robots.

Typedef Documentation

typedef struct gz_power_data gz_power_data_t
 

Power interface.

typedef struct gz_power gz_power_t
 

The power interface.


Function Documentation

gz_power_t* gz_power_alloc  ) 
 

Create an interface.

void gz_power_free gz_power_t self  ) 
 

Destroy an interface.

int gz_power_create gz_power_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_power_destroy gz_power_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_power_open gz_power_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_power_close gz_power_t self  ) 
 

Close the interface (client).

int gz_power_lock gz_power_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_power_unlock gz_power_t self  ) 
 

Unlock the interface.

int gz_power_post gz_power_t self  ) 
 

Tell clients that new data is available.


Last updated 12 September 2005 21:38:45