Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

REB Class Reference

#include <reb.h>

Inherits Driver.

List of all members.

Public Member Functions

 REB (ConfigFile *cf, int section)
virtual void Main ()
 Main method for driver thread.

virtual int Subscribe (player_device_id_t id)
 Subscribe to this driver.

virtual int Unsubscribe (player_device_id_t id)
 Unsubscribe from this driver.

virtual int Setup ()
 Initialize the driver.

virtual int Shutdown ()
 Finalize the driver.

void Restart ()
void ReadConfig ()
void SetOdometry (int, int, short)
void SetIRState (int)
void UpdateData (void)
void UpdateIRData (player_ir_data_t *)
void UpdatePowerData (player_power_data_t *)
void UpdatePosData (player_position_data_t *)
void ConfigAD (int, int)
unsigned short ReadAD (int)
void ReadAllIR (uint16_t *ir)
void SetSpeed (int, int)
int ReadSpeed (int)
void SetPos (int, int)
void SetPosCounter (int, int)
int ReadPos (int)
unsigned char ReadStatus (int, int *, int *)
void ConfigPosPID (int, int, int, int)
void ConfigSpeedPID (int, int, int, int)
void ConfigSpeedProfile (int, int, int)


Constructor & Destructor Documentation

REB::REB ConfigFile cf,
int  section
 


Member Function Documentation

void REB::Main  )  [virtual]
 

Main method for driver thread.

Most drivers have their own thread of execution, created using StartThread(); this is the entry point for the driver thread, and must be overloaded by all threaded drivers.

Reimplemented from Driver.

int REB::Subscribe player_device_id_t  id  )  [virtual]
 

Subscribe to this driver.

The Subscribe() and Unsubscribe() methods are used to control subscriptions to the driver; a driver MAY override them, but usually won't.

Parameters:
id Id of the device to subscribe to (the driver may have more than one interface).
Returns:
Returns 0 on success.

Reimplemented from Driver.

int REB::Unsubscribe player_device_id_t  id  )  [virtual]
 

Unsubscribe from this driver.

The Subscribe() and Unsubscribe() methods are used to control subscriptions to the driver; a driver MAY override them, but usually won't.

Parameters:
id Id of the device to unsubscribe from (the driver may have more than one interface).
Returns:
Returns 0 on success.

Reimplemented from Driver.

int REB::Setup  )  [virtual]
 

Initialize the driver.

This function is called with the first client subscribes; it MUST be implemented by the driver.

Returns:
Returns 0 on success.

Implements Driver.

int REB::Shutdown  )  [virtual]
 

Finalize the driver.

This function is called with the last client unsubscribes; it MUST be implemented by the driver.

Returns:
Returns 0 on success.

Implements Driver.

void REB::Restart  ) 
 

void REB::ReadConfig  ) 
 

void REB::SetOdometry int  ,
int  ,
short 
 

void REB::SetIRState int   ) 
 

void REB::UpdateData void   ) 
 

void REB::UpdateIRData player_ir_data_t  ) 
 

void REB::UpdatePowerData player_power_data_t  ) 
 

void REB::UpdatePosData player_position_data_t  ) 
 

void REB::ConfigAD int  ,
int 
 

unsigned short REB::ReadAD int   ) 
 

void REB::ReadAllIR uint16_t *  ir  ) 
 

void REB::SetSpeed int  ,
int 
 

int REB::ReadSpeed int   ) 
 

void REB::SetPos int  ,
int 
 

void REB::SetPosCounter int  ,
int 
 

int REB::ReadPos int   ) 
 

unsigned char REB::ReadStatus int  ,
int *  ,
int * 
 

void REB::ConfigPosPID int  ,
int  ,
int  ,
int 
 

void REB::ConfigSpeedPID int  ,
int  ,
int  ,
int 
 

void REB::ConfigSpeedProfile int  ,
int  ,
int 
 


The documentation for this class was generated from the following files:
Generated on Tue May 3 14:16:05 2005 for Player by doxygen 1.3.6