RFLEX Class Reference

List of all members.

Public Member Functions

 RFLEX (ConfigFile *cf, int section)
virtual void Main ()
 Main method for driver thread.
virtual int Subscribe (player_devaddr_t addr)
 Subscribe to this driver.
virtual int Unsubscribe (player_devaddr_t addr)
 Unsubscribe from this driver.
virtual int Setup ()
 Initialize the driver.
virtual int Shutdown ()
 Finalize the driver.
virtual void StartThread (void)
 Start the driver thread.
virtual void StopThread (void)
 Cancel (and wait for termination) of the driver thread.
int ProcessMessage (MessageQueue *resp_queue, player_msghdr *hdr, void *data)
 Message handler.

Public Attributes

bool ThreadAlive

Static Public Attributes

static int joy_control

Member Function Documentation

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.

References StartThread().

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.

References StopThread().

void RFLEX::StartThread ( void   )  [virtual]

Start the driver thread.

This method is usually called from the overloaded Setup() method to create the driver thread. This will call Main().

Reimplemented from Driver.

References Driver::driverthread, and Driver::DummyMain().

Referenced by Setup().

void RFLEX::StopThread ( void   )  [virtual]

Cancel (and wait for termination) of the driver thread.

This method is usually called from the overloaded Shutdown() method to terminate the driver thread.

Reimplemented from Driver.

References Driver::driverthread, Driver::Lock(), and Driver::Unlock().

Referenced by Shutdown().

int RFLEX::Subscribe ( player_devaddr_t  addr  )  [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:
addr Address of the device to subscribe to (the driver may have more than one interface).
Returns:
Returns 0 on success.

Reimplemented from Driver.

References PLAYER_BUMPER_CODE, PLAYER_IR_CODE, PLAYER_POSITION2D_CODE, PLAYER_SONAR_CODE, and Driver::Subscribe().

int RFLEX::Unsubscribe ( player_devaddr_t  addr  )  [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:
addr Address of the device to unsubscribe from (the driver may have more than one interface).
Returns:
Returns 0 on success.

Reimplemented from Driver.

References PLAYER_BUMPER_CODE, PLAYER_IR_CODE, PLAYER_POSITION2D_CODE, PLAYER_SONAR_CODE, and Driver::Unsubscribe().


The documentation for this class was generated from the following files:

Last updated 12 September 2005 21:38:45