Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

EnergyProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The EnergyProxy class is used to read from an energy device.


Public Member Functions

 EnergyProxy (PlayerClient *pc, unsigned short index, unsigned char access= 'c')
 ~EnergyProxy ()
void FillData (player_msghdr_t hdr, const char *buffer)
void Print ()
 Print out the current bumper state.


Public Attributes

double joules
double watts
bool charging


Constructor & Destructor Documentation

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

Constructor. Leave the access field empty to start unconnected.

EnergyProxy::~EnergyProxy  )  [inline]
 


Member Function Documentation

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

Print out the current bumper state.

Reimplemented from ClientProxy.


Member Data Documentation

double EnergyProxy::joules
 

These members give the current amount of energy stored (Joules) and the amount of energy current being consumed (Watts). The charging flag is TRUE if we are currently charging, else FALSE.

double EnergyProxy::watts
 

bool EnergyProxy::charging
 


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