PlayerCc::BumperProxy Class Reference

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

#include <playerc++.h>

Inheritance diagram for PlayerCc::BumperProxy:
Collaboration diagram for PlayerCc::BumperProxy:

List of all members.


Detailed Description

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

Public Member Functions

 BumperProxy (PlayerClient *aPc, uint32_t aIndex=0)
 Constructor.
 ~BumperProxy ()
 Destructor.
uint32_t GetCount () const
 Returns how many bumpers are in underlying device.
uint32_t IsBumped (uint32_t aIndex) const
 Returns true if the specified bumper has been bumped, false otherwise.
bool IsAnyBumped ()
 Returns true if any bumper has been bumped, false otherwise.
void RequestBumperConfig ()
 Requests the geometries of the bumpers.
uint32_t GetPoseCount () const
 Returns the number bumper poses.
player_bumper_define_t GetPose (uint32_t aIndex) const
 Returns a specific bumper pose.
bool operator[] (uint32_t aIndex) const
 BumperProxy data access operator.

Private Member Functions

void Subscribe (uint32_t aIndex)
void Unsubscribe ()

Private Attributes

playerc_bumper_tmDevice

Member Function Documentation

bool PlayerCc::BumperProxy::operator[] ( uint32_t  aIndex) const [inline]

BumperProxy data access operator.

This operator provides an alternate way of access the actuator data. For example, given a BumperProxy named bp, the following expressions are equivalent: bp.IsBumped[0] and bp[0].


The documentation for this class was generated from the following file: