Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

RFLEX Class Reference

#include <rflex.h>

Inherits Driver.

List of all members.

Public Member Functions

 RFLEX (ConfigFile *cf, int section)
virtual void GetOptions (ConfigFile *cf, int section, rflex_config_t *rflex_configs)
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.


Static Public Attributes

int joy_control


Constructor & Destructor Documentation

RFLEX::RFLEX ConfigFile cf,
int  section
 


Member Function Documentation

void RFLEX::GetOptions ConfigFile cf,
int  section,
rflex_config_t rflex_configs
[virtual]
 

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


Member Data Documentation

int RFLEX::joy_control [static]
 


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