Gazebo logo

wifi
[libgazebo]


Classes

struct  gz_wifi_link
 Individual link properties. More...
struct  gz_wifi_data
struct  gz_wifi
 The truth interface. More...

Defines

#define GAZEBO_WIFI_MAX_LINKS   16
#define GAZEBO_WIFI_QUAL_DBM   1
 link quality is in dBm

Typedefs

typedef gz_wifi_link gz_wifi_link_t
 Individual link properties.
typedef gz_wifi_data gz_wifi_data_t
typedef gz_wifi gz_wifi_t
 The truth interface.

Functions

gz_wifi_tgz_wifi_alloc ()
 Create an interface.
void gz_wifi_free (gz_wifi_t *self)
 Destroy an interface.
int gz_wifi_create (gz_wifi_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_wifi_destroy (gz_wifi_t *self)
int gz_wifi_open (gz_wifi_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_wifi_close (gz_wifi_t *self)
 Close the interface (client).
int gz_wifi_lock (gz_wifi_t *self, int blocking)
void gz_wifi_unlock (gz_wifi_t *self)
 Unlock the interface.

Detailed Description

Data on simulated WiFi link quality.

Define Documentation

#define GAZEBO_WIFI_MAX_LINKS   16
 

#define GAZEBO_WIFI_QUAL_DBM   1
 

link quality is in dBm


Typedef Documentation

typedef struct gz_wifi_link gz_wifi_link_t
 

Individual link properties.

typedef struct gz_wifi_data gz_wifi_data_t
 

typedef struct gz_wifi gz_wifi_t
 

The truth interface.


Function Documentation

gz_wifi_t* gz_wifi_alloc  ) 
 

Create an interface.

void gz_wifi_free gz_wifi_t self  ) 
 

Destroy an interface.

int gz_wifi_create gz_wifi_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_wifi_destroy gz_wifi_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_wifi_open gz_wifi_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_wifi_close gz_wifi_t self  ) 
 

Close the interface (client).

int gz_wifi_lock gz_wifi_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_wifi_unlock gz_wifi_t self  ) 
 

Unlock the interface.


Last updated 12 September 2005 21:38:45