Gazebo logo

gripper
[libgazebo]


Classes

struct  gz_gripper_data
 Gripper data interface. More...
struct  gz_gripper
 The gripper interface. More...

Typedefs

typedef gz_gripper_data gz_gripper_data_t
 Gripper data interface.
typedef gz_gripper gz_gripper_t
 The gripper interface.

Functions

gz_gripper_tgz_gripper_alloc ()
 Create an interface.
void gz_gripper_free (gz_gripper_t *self)
 Destroy an interface.
int gz_gripper_create (gz_gripper_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_gripper_destroy (gz_gripper_t *self)
int gz_gripper_open (gz_gripper_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_gripper_close (gz_gripper_t *self)
 Close the interface (client).
int gz_gripper_lock (gz_gripper_t *self, int blocking)
void gz_gripper_unlock (gz_gripper_t *self)
 Unlock the interface.

Detailed Description

The gripper interface allows control of a simple 2-DOF gripper, such as that found on the Pioneer series robots.

Typedef Documentation

typedef struct gz_gripper_data gz_gripper_data_t
 

Gripper data interface.

typedef struct gz_gripper gz_gripper_t
 

The gripper interface.


Function Documentation

gz_gripper_t* gz_gripper_alloc  ) 
 

Create an interface.

void gz_gripper_free gz_gripper_t self  ) 
 

Destroy an interface.

int gz_gripper_create gz_gripper_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_gripper_destroy gz_gripper_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_gripper_open gz_gripper_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_gripper_close gz_gripper_t self  ) 
 

Close the interface (client).

int gz_gripper_lock gz_gripper_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_gripper_unlock gz_gripper_t self  ) 
 

Unlock the interface.


Last updated 12 September 2005 21:38:45