Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

GripperProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The GripperProxy class is used to control a gripper device. The latest gripper data held in a handful of class attributes. A single method provides user control.


Public Member Functions

 GripperProxy (PlayerClient *pc, unsigned short index, unsigned char access='c')
int SetGrip (unsigned char cmd, unsigned char arg=0)
void FillData (player_msghdr_t hdr, const char *buffer)
void Print ()
 Print out current gripper state.


Public Attributes

unsigned char state
 The latest raw gripper data.

unsigned char beams
 The latest raw gripper data.

bool outer_break_beam
bool inner_break_beam
bool paddles_open
bool paddles_closed
bool paddles_moving
bool gripper_error
bool lift_up
bool lift_down
bool lift_moving
bool lift_error


Constructor & Destructor Documentation

GripperProxy::GripperProxy PlayerClient pc,
unsigned short  index,
unsigned char  access = 'c'
[inline]
 

The client calls this method to make a new proxy. Leave access empty to start unconnected.


Member Function Documentation

int GripperProxy::SetGrip unsigned char  cmd,
unsigned char  arg = 0
 

Send a gripper command. Look in the Player user manual for details on the command and argument. Returns 0 if everything's ok, and -1 otherwise (that's bad).

void GripperProxy::FillData player_msghdr_t  hdr,
const char *  buffer
[virtual]
 

All proxies must provide this method. It is used internally to parse new data when it is received.

Reimplemented from ClientProxy.

void GripperProxy::Print  )  [virtual]
 

Print out current gripper state.

Reimplemented from ClientProxy.


Member Data Documentation

unsigned char GripperProxy::state
 

The latest raw gripper data.

unsigned char GripperProxy::beams
 

The latest raw gripper data.

bool GripperProxy::outer_break_beam
 

These boolean variables indicate the state of the gripper

bool GripperProxy::inner_break_beam
 

These boolean variables indicate the state of the gripper

bool GripperProxy::paddles_open
 

These boolean variables indicate the state of the gripper

bool GripperProxy::paddles_closed
 

These boolean variables indicate the state of the gripper

bool GripperProxy::paddles_moving
 

These boolean variables indicate the state of the gripper

bool GripperProxy::gripper_error
 

These boolean variables indicate the state of the gripper

bool GripperProxy::lift_up
 

These boolean variables indicate the state of the gripper

bool GripperProxy::lift_down
 

These boolean variables indicate the state of the gripper

bool GripperProxy::lift_moving
 

These boolean variables indicate the state of the gripper

bool GripperProxy::lift_error
 

These boolean variables indicate the state of the gripper


The documentation for this class was generated from the following file:
Generated on Tue May 3 14:15:50 2005 for Player by doxygen 1.3.6