abstraction of an XID device More...
#include <xid_device_driver/xid_device_t.h>
Public Member Functions | |
| xid_device_t (boost::shared_ptr< xid_con_t > xid_con, const std::wstring &devconfig_path=L"") | |
| xid_device_t constructor | |
| virtual | ~xid_device_t (void) |
| void | poll_for_response () |
| Poll the COM interface for a button press event. | |
| std::size_t | response_queue_size () const |
| Number of responses in the response queue. | |
| bool | has_queued_responses () const |
| void | clear_response_queue () |
| Clears the response queue. | |
| response | get_next_response () |
| Returns the next response in the queue waiting for processing. | |
| int | get_button_count () const |
| Number of buttons the device has. | |
| std::wstring | input_name_prefix () const |
| Prefix used for the device for GUI display purposes. | |
Detailed Description
abstraction of an XID device
Definition at line 87 of file xid_device_t.h.
Constructor & Destructor Documentation
| cedrus::xid_device_t::xid_device_t | ( | boost::shared_ptr< xid_con_t > | xid_con, |
| const std::wstring & | devconfig_path = L"" |
||
| ) |
xid_device_t constructor
- Parameters:
-
[in] xid_con xid_con_t object to use [in] devconfig_path path to devconfig files. Defaults to an empty string. If no path is used, very conservative default values are used and results may not be what you expect. It's highly reccommended to use the devconfig files.
Definition at line 37 of file xid_device_t.cpp.
| cedrus::xid_device_t::~xid_device_t | ( | void | ) | [virtual] |
Definition at line 47 of file xid_device_t.cpp.
Member Function Documentation
| void cedrus::xid_device_t::clear_response_queue | ( | ) |
Clears the response queue.
Definition at line 105 of file xid_device_t.cpp.
| int cedrus::xid_device_t::get_button_count | ( | ) | const |
Number of buttons the device has.
- Returns:
- number of buttons
Definition at line 51 of file xid_device_t.cpp.
| cedrus::response cedrus::xid_device_t::get_next_response | ( | ) |
Returns the next response in the queue waiting for processing.
Definition at line 113 of file xid_device_t.cpp.
| bool cedrus::xid_device_t::has_queued_responses | ( | ) | const |
- Returns:
- true if there are queued responses
Definition at line 100 of file xid_device_t.cpp.
| std::wstring cedrus::xid_device_t::input_name_prefix | ( | ) | const |
Prefix used for the device for GUI display purposes.
- Returns:
- "Button" for Lumina, RB-series pads, and unknown devices. "Voice Response" for SV-1 Voice Key systems.
Definition at line 120 of file xid_device_t.cpp.
| void cedrus::xid_device_t::poll_for_response | ( | ) |
Poll the COM interface for a button press event.
If there is a button press event, it is placed into an internal response queue.
Definition at line 59 of file xid_device_t.cpp.
| std::size_t cedrus::xid_device_t::response_queue_size | ( | ) | const |
Number of responses in the response queue.
- Returns:
- number of responses pending processing.
Definition at line 95 of file xid_device_t.cpp.
The documentation for this class was generated from the following files:
