Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

Phx::LogicalInputEngine::ButtonDriver Class Reference

An abstract interface to a driver for a logical button created by the LogicalInputEngine. More...

#include <PhxLogicalInputEngine.h>

Inheritance diagram for Phx::LogicalInputEngine::ButtonDriver:

Phx::LockedPtrInterface< ButtonDriver > Phx::LogicalInputEngine::AnalogButtonDriver Phx::LogicalInputEngine::DigitalButtonDriver List of all members.

Public Types

typedef LogicalInputEngine::ButtonState ButtonState

Public Member Functions

virtual ButtonState buttonState (void) const =0
 Returns the state of the button.
const String & name (void) const
 Returns the name of the logical button this driver is used for.

Protected Member Functions

void setName (const String &name)

Detailed Description

An abstract interface to a driver for a logical button created by the LogicalInputEngine.

See also:
AnalogButtonDriver

DigitalButtonDriver


Member Function Documentation

virtual ButtonState Phx::LogicalInputEngine::ButtonDriver::buttonState void   )  const [pure virtual]
 

Returns the state of the button.

Returns:
The current state of this logical button as determined by the driver subclass.

const String& Phx::LogicalInputEngine::ButtonDriver::name void   )  const [inline]
 

Returns the name of the logical button this driver is used for.

Returns:
The name of the button this ButtonDriver is driving.


The documentation for this class was generated from the following file:
Generated on Wed Dec 21 22:05:38 2005 for Phoenix OSFS by  doxygen 1.4.2