Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

BumperProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The BumperProxy class is used to read from a bumper device.


Public Member Functions

 BumperProxy (PlayerClient *pc, unsigned short index, unsigned char access= 'c')
 ~BumperProxy ()
bool Bumped (const unsigned int i)
bool BumpedAny ()
int GetBumperGeom (player_bumper_geom_t *bumper_defs)
uint8_t BumperCount () const
 Returns the number of bumper readings.

void FillData (player_msghdr_t hdr, const char *buffer)
void Print ()
 Print out the current bumper state.


Constructor & Destructor Documentation

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

Constructor. Leave the access field empty to start unconnected.

BumperProxy::~BumperProxy  )  [inline]
 


Member Function Documentation

bool BumperProxy::Bumped const unsigned int  i  ) 
 

Returns 1 if the specified bumper has been bumped, 0 otherwise.

bool BumperProxy::BumpedAny  ) 
 

Returns 1 if any bumper has been bumped, 0 otherwise.

int BumperProxy::GetBumperGeom player_bumper_geom_t bumper_defs  ) 
 

Requests the geometries of the bumpers. Returns -1 if anything went wrong, 0 if OK

uint8_t BumperProxy::BumperCount  )  const [inline]
 

Returns the number of bumper readings.

void BumperProxy::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 BumperProxy::Print  )  [virtual]
 

Print out the current bumper state.

Reimplemented from ClientProxy.


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