Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

IRProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The IRProxy class is used to control an ir device.


Public Member Functions

 IRProxy (PlayerClient *pc, unsigned short index, unsigned char access= 'c')
int SetIRState (unsigned char state)
 Enable/disable the IRs.

int GetIRPose ()
 Request the poses of the IRs.

void SetRangeParams (int which, double m, double)
 Set range parameters.

void SetStdDevParams (int which, double m, double b)
 Set standard deviation parameters.

double CalcStdDev (int w, unsigned short range)
 Calculate standard deviations.

unsigned short operator[] (unsigned int index)
void FillData (player_msghdr_t hdr, const char *buffer)
void Print ()
 Print out current IR data.


Public Attributes

unsigned short ranges [PLAYER_IR_MAX_SAMPLES]
 Latest range readings.

unsigned short voltages [PLAYER_IR_MAX_SAMPLES]
 Latest voltage readings.

double stddev [PLAYER_IR_MAX_SAMPLES]
 Standard deviations.

double params [PLAYER_IR_MAX_SAMPLES][2]
 Distance regression params.

double sparams [PLAYER_IR_MAX_SAMPLES][2]
 Standard deviation regression params.

player_ir_pose_t ir_pose


Constructor & Destructor Documentation

IRProxy::IRProxy PlayerClient pc,
unsigned short  index,
unsigned char  access = 'c'
 

Constructor. Leave the access field empty to start unconnected.


Member Function Documentation

int IRProxy::SetIRState unsigned char  state  ) 
 

Enable/disable the IRs.

int IRProxy::GetIRPose  ) 
 

Request the poses of the IRs.

void IRProxy::SetRangeParams int  which,
double  m,
double 
 

Set range parameters.

void IRProxy::SetStdDevParams int  which,
double  m,
double  b
 

Set standard deviation parameters.

double IRProxy::CalcStdDev int  w,
unsigned short  range
 

Calculate standard deviations.

unsigned short IRProxy::operator[] unsigned int  index  )  [inline]
 

Range access operator. This operator provides an alternate way of access the range data. For example, given a IRProxy named ip, the following expressions are equivalent: ip.ranges[0] and ip[0].

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

Print out current IR data.

Reimplemented from ClientProxy.


Member Data Documentation

unsigned short IRProxy::ranges[PLAYER_IR_MAX_SAMPLES]
 

Latest range readings.

unsigned short IRProxy::voltages[PLAYER_IR_MAX_SAMPLES]
 

Latest voltage readings.

double IRProxy::stddev[PLAYER_IR_MAX_SAMPLES]
 

Standard deviations.

double IRProxy::params[PLAYER_IR_MAX_SAMPLES][2]
 

Distance regression params.

double IRProxy::sparams[PLAYER_IR_MAX_SAMPLES][2]
 

Standard deviation regression params.

player_ir_pose_t IRProxy::ir_pose
 

Poses of the IRs.


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