Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

Khepera Class Reference

#include <khepera.h>

Inherits Driver.

List of all members.

Public Member Functions

 Khepera (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.

short khtons (short in)
short ntokhs (short in)
void ReadConfig ()
int ResetOdometry ()
void SetIRState (int)
void UpdateData (void)
void UpdateIRData (player_ir_data_t *)
void UpdatePosData (player_position_data_t *)
unsigned short ReadAD (int)
int ReadAllIR (player_ir_data_t *)
int SetSpeed (int, int)
int ReadSpeed (int *, int *)
int SetPos (int, int)
int SetPosCounter (int, int)
int ReadPos (int *, int *)


Constructor & Destructor Documentation

Khepera::Khepera ConfigFile cf,
int  section
 


Member Function Documentation

void Khepera::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 Khepera::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 Khepera::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 Khepera::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 Khepera::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.

short Khepera::khtons short  in  ) 
 

short Khepera::ntokhs short  in  ) 
 

void Khepera::ReadConfig  ) 
 

int Khepera::ResetOdometry  ) 
 

void Khepera::SetIRState int   ) 
 

void Khepera::UpdateData void   ) 
 

void Khepera::UpdateIRData player_ir_data_t  ) 
 

void Khepera::UpdatePosData player_position_data_t  ) 
 

unsigned short Khepera::ReadAD int   ) 
 

int Khepera::ReadAllIR player_ir_data_t  ) 
 

int Khepera::SetSpeed int  ,
int 
 

int Khepera::ReadSpeed int *  ,
int * 
 

int Khepera::SetPos int  ,
int 
 

int Khepera::SetPosCounter int  ,
int 
 

int Khepera::ReadPos int *  ,
int * 
 


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