#include <vrpn_Xkeys.h>
Public Member Functions | |
vrpn_Xkeys_Jog_And_Shuttle68 (const char *name, vrpn_Connection *c=0) | |
virtual | ~vrpn_Xkeys_Jog_And_Shuttle68 () |
virtual void | mainloop () |
Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop(). | |
![]() | |
vrpn_Analog (const char *name, vrpn_Connection *c=NULL) | |
void | print (void) |
vrpn_int32 | getNumChannels (void) const |
![]() | |
vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL) | |
Names the device and assigns or opens connection, calls registration methods. | |
virtual | ~vrpn_BaseClass () |
![]() | |
vrpn_BaseClassUnique () | |
virtual | ~vrpn_BaseClassUnique () |
Unregister all of the message handlers that were to be autodeleted. | |
vrpn_Connection * | connectionPtr () |
Returns a pointer to the connection this object is using. | |
![]() | |
virtual void | set_momentary (vrpn_int32 which_button) |
virtual void | set_toggle (vrpn_int32 which_button, vrpn_int32 current_state) |
virtual void | set_all_momentary (void) |
virtual void | set_all_toggle (vrpn_int32 default_state) |
void | set_alerts (vrpn_int32) |
![]() | |
vrpn_Button (const char *name, vrpn_Connection *c=NULL) | |
virtual | ~vrpn_Button (void) |
void | print (void) |
![]() | |
vrpn_Dial (const char *name, vrpn_Connection *c=NULL) | |
Protected Member Functions | |
void | report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY) |
void | report (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY) |
void | decodePacket (size_t bytes, vrpn_uint8 *buffer) |
![]() | |
virtual void | setLEDs (LED_STATE red, LED_STATE green) |
vrpn_Xkeys_v2 (vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c=0, vrpn_uint16 vendor=0, vrpn_uint16 product=0, bool toggle_light=true) | |
~vrpn_Xkeys_v2 () | |
![]() | |
void | init_hid () |
void | on_data_received (size_t bytes, vrpn_uint8 *buffer) |
Derived class reimplements this callback. | |
int | register_types (void) |
Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. | |
vrpn_Xkeys (vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c=0, vrpn_uint16 vendor=0, vrpn_uint16 product=0, bool toggle_light=true) | |
virtual | ~vrpn_Xkeys () |
![]() | |
virtual int | init (void) |
Initialize things that the constructor can't. Returns 0 on success, -1 on failure. | |
virtual int | register_senders (void) |
Register the sender for this device (by default, the name of the device). Return 0 on success, -1 on fail. | |
vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL) | |
Names the device and assigns or opens connection, calls registration methods. | |
virtual | ~vrpn_BaseClass () |
![]() | |
int | register_autodeleted_handler (vrpn_int32 type, vrpn_MESSAGEHANDLER handler, void *userdata, vrpn_int32 sender=vrpn_ANY_SENDER) |
Registers a handler with the connection, and remembers to delete at destruction. | |
int | send_text_message (const char *msg, struct timeval timestamp, vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL, vrpn_uint32 level=0) |
Sends a NULL-terminated text message from the device d_sender_id. | |
SendTextMessageBoundCall | send_text_message (vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL) |
Returns an object you can stream into to send a text message from the device like send_text_message(vrpn_TEXT_WARNING) << "Value of i is: " << i; This use requires including vrpn_SendTextMessageStreamProxy.h. | |
void | server_mainloop (void) |
Handles functions that all servers should provide in their mainloop() (ping/pong, for example) Should be called by all servers in their mainloop() | |
void | client_mainloop (void) |
Handles functions that all clients should provide in their mainloop() (warning of no server, for example) Should be called by all clients in their mainloop() | |
vrpn_BaseClassUnique () | |
virtual | ~vrpn_BaseClassUnique () |
Unregister all of the message handlers that were to be autodeleted. | |
vrpn_Connection * | connectionPtr () |
Returns a pointer to the connection this object is using. | |
![]() | |
void | send_data (size_t bytes, const vrpn_uint8 *buffer) |
Call this to send data to the device. | |
void | send_feature_report (size_t bytes, const vrpn_uint8 *buffer) |
Call this to send a feature report to the device - first byte must be Report ID (or 0x0 for devices without numbered reports) | |
int | get_feature_report (size_t bytes, vrpn_uint8 *buffer) |
Call this to get a feature report from the device - first byte must be Report ID (or 0x0 for devices without numbered reports) | |
vrpn_HidInterface (vrpn_HidAcceptor *acceptor, vrpn_uint16 vendor=0, vrpn_uint16 product=0, hid_device *device=NULL) | |
Constructor If we already have a HID device from some other source, it can be passed and we'll take ownership: still need the acceptor for reconnect, we just won't do it right away. | |
vrpn_HidInterface (vrpn_HidAcceptor *acceptor, hid_device *device) | |
Simplified constructor that just takes an acceptor and an underlying HID device (both non-optional). | |
vrpn_HidInterface (const char *device_path, vrpn_HidAcceptor *acceptor, vrpn_uint16 vendor=0, vrpn_uint16 product=0) | |
Constructor If we already know the path to the device we want, we can pass it in and open it directly: still need the acceptor for reconnect enumeration, we just won't do it right away. | |
virtual | ~vrpn_HidInterface () |
virtual bool | connected () const |
Returns true iff the last device I/O succeeded. | |
virtual void | update () |
Polls the device buffers and causes on_data_received callbacks if appropriate You NEED to call this frequently to ensure the OS doesn't drop data. | |
virtual bool | reconnect () |
Tries to reconnect to an acceptable device. Call this if you suspect a hotplug event has occurred. | |
vrpn_uint16 | vendor () const |
Returns USB vendor ID of connected device May not contain valid if an already-open device was provided to the constructor. | |
vrpn_uint16 | product () const |
Returns USB product ID of connected device May not contain valid if an already-open device was provided to the constructor. | |
int | interface_number () const |
Returns the USB interface number of connected device May not contain valid information on all platforms or if an already-open device was provided to the constructor. | |
![]() | |
virtual int | register_types (void) |
Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. | |
virtual vrpn_int32 | encode_to (char *buf) |
virtual void | report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY, const struct timeval time=vrpn_ANALOG_NOW) |
Send a report only if something has changed (for servers) Optionally, tell what time to stamp the value with. | |
virtual void | report (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY, const struct timeval time=vrpn_ANALOG_NOW) |
Send a report whether something has changed or not (for servers) Optionally, tell what time to stamp the value with. | |
vrpn_Analog (const char *name, vrpn_Connection *c=NULL) | |
void | print (void) |
vrpn_int32 | getNumChannels (void) const |
![]() | |
vrpn_Button_Filter (const char *, vrpn_Connection *c=NULL) | |
virtual vrpn_int32 | encode_states_to (char *buf) |
Encode a message describing the state of all buttons. | |
virtual void | report_changes (void) |
virtual void | set_momentary (vrpn_int32 which_button) |
virtual void | set_toggle (vrpn_int32 which_button, vrpn_int32 current_state) |
virtual void | set_all_momentary (void) |
virtual void | set_all_toggle (vrpn_int32 default_state) |
void | set_alerts (vrpn_int32) |
![]() | |
virtual int | register_types (void) |
Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. | |
virtual void | report_states (void) |
virtual vrpn_int32 | encode_to (char *buf, vrpn_int32 button, vrpn_int32 state) |
Encode a message describing the new state of a button. | |
vrpn_Button (const char *name, vrpn_Connection *c=NULL) | |
virtual | ~vrpn_Button (void) |
void | print (void) |
![]() | |
virtual int | register_types (void) |
Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. | |
virtual vrpn_int32 | encode_to (char *buf, vrpn_int32 buflen, vrpn_int32 dial, vrpn_float64 delta) |
virtual void | report_changes (void) |
virtual void | report (void) |
vrpn_Dial (const char *name, vrpn_Connection *c=NULL) | |
Protected Attributes | |
vrpn_uint8 | _lastDial |
![]() | |
struct timeval | _timestamp |
vrpn_HidAcceptor * | _filter |
bool | _toggle_light |
![]() | |
vrpn_Connection * | d_connection |
Connection that this object talks to. | |
char * | d_servicename |
Name of this device, not including the connection part. | |
vrpn_int32 | d_sender_id |
Sender ID registered with the connection. | |
vrpn_int32 | d_text_message_id |
ID for text messages. | |
vrpn_int32 | d_ping_message_id |
Ask the server if they are there. | |
vrpn_int32 | d_pong_message_id |
Server telling that it is there. | |
bool | shutup |
![]() | |
vrpn_HidAcceptor * | m_acceptor |
This is the HidAcceptor we use when reconnecting. | |
bool | m_working |
vrpn_uint16 | m_vendor |
vrpn_uint16 | m_product |
int | m_interface |
vrpn_uint16 | m_vendor_sought |
What vendor we want. | |
vrpn_uint16 | m_product_sought |
What product we want. | |
![]() | |
vrpn_float64 | channel [vrpn_CHANNEL_MAX] |
vrpn_float64 | last [vrpn_CHANNEL_MAX] |
vrpn_int32 | num_channel |
struct timeval | timestamp |
vrpn_int32 | channel_m_id |
int | status |
![]() | |
int | send_alerts |
vrpn_int32 | alert_message_id |
vrpn_int32 | buttonstate [vrpn_BUTTON_MAX_BUTTONS] |
![]() | |
unsigned char | buttons [vrpn_BUTTON_MAX_BUTTONS] |
unsigned char | lastbuttons [vrpn_BUTTON_MAX_BUTTONS] |
vrpn_int32 | minrate [vrpn_BUTTON_MAX_BUTTONS] |
vrpn_int32 | num_buttons |
struct timeval | timestamp |
vrpn_int32 | change_message_id |
vrpn_int32 | states_message_id |
vrpn_int32 | admin_message_id |
![]() | |
vrpn_float64 | dials [vrpn_DIAL_MAX] |
vrpn_int32 | num_dials |
struct timeval | timestamp |
vrpn_int32 | change_m_id |
Additional Inherited Members | |
![]() | |
bool | shutup |
![]() | |
vrpn_int32 | buttonstate [vrpn_BUTTON_MAX_BUTTONS] |
![]() | |
enum | LED_STATE { Off , On , Flash } |
![]() | |
static int VRPN_CALLBACK | on_connect (void *thisPtr, vrpn_HANDLERPARAM p) |
static int VRPN_CALLBACK | on_last_disconnect (void *thisPtr, vrpn_HANDLERPARAM p) |
![]() | |
static int | encode_text_message_to_buffer (char *buf, vrpn_TEXT_SEVERITY severity, vrpn_uint32 level, const char *msg) |
Encodes the body of the text message into a buffer, preparing for sending. | |
static int | decode_text_message_from_buffer (char *msg, vrpn_TEXT_SEVERITY *severity, vrpn_uint32 *level, const char *buf) |
Decodes the body of the text message from a buffer from the connection. | |
![]() | |
static int VRPN_CALLBACK | handle_ping_message (void *userdata, vrpn_HANDLERPARAM p) |
Definition at line 245 of file vrpn_Xkeys.h.
vrpn_Xkeys_Jog_And_Shuttle68::vrpn_Xkeys_Jog_And_Shuttle68 | ( | const char * | name, |
vrpn_Connection * | c = 0 ) |
Definition at line 504 of file vrpn_Xkeys.C.
References vrpn_Xkeys::_filter, _lastDial, vrpn_Button::buttons, vrpn_Analog::channel, vrpn_Analog::last, vrpn_Button::lastbuttons, vrpn_Button::num_buttons, vrpn_Analog::num_channel, vrpn_Dial::num_dials, vrpn_Analog::vrpn_Analog(), vrpn_Button_Filter::vrpn_Button_Filter(), vrpn_Dial::vrpn_Dial(), and vrpn_Xkeys_v2::vrpn_Xkeys_v2().
|
inlinevirtual |
Definition at line 248 of file vrpn_Xkeys.h.
|
protectedvirtual |
Implements vrpn_Xkeys.
Definition at line 555 of file vrpn_Xkeys.C.
References _lastDial, vrpn_Button::buttons, vrpn_Analog::channel, vrpn_Dial::dials, and report().
|
virtual |
Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop().
Implements vrpn_Xkeys.
Definition at line 522 of file vrpn_Xkeys.C.
References vrpn_Xkeys::_timestamp, vrpn_Button_Filter::report_changes(), vrpn_BaseClassUnique::server_mainloop(), vrpn_HidInterface::update(), and vrpn_gettimeofday.
|
protected |
Definition at line 533 of file vrpn_Xkeys.C.
References vrpn_Xkeys::_timestamp, vrpn_Analog::report(), vrpn_Dial::report(), vrpn_Button::report_changes(), vrpn_Analog::timestamp, vrpn_Button::timestamp, and vrpn_Dial::timestamp.
Referenced by decodePacket().
|
protected |
Definition at line 544 of file vrpn_Xkeys.C.
References vrpn_Xkeys::_timestamp, vrpn_Analog::report_changes(), vrpn_Button::report_changes(), vrpn_Dial::report_changes(), vrpn_Analog::timestamp, vrpn_Button::timestamp, and vrpn_Dial::timestamp.
|
protected |
Definition at line 263 of file vrpn_Xkeys.h.
Referenced by decodePacket(), and vrpn_Xkeys_Jog_And_Shuttle68().