vrpn 07.35
Virtual Reality Peripheral Network
 
Loading...
Searching...
No Matches
vrpn_Xkeys_v2 Class Reference

#include <vrpn_Xkeys.h>

Inheritance diagram for vrpn_Xkeys_v2:
Collaboration diagram for vrpn_Xkeys_v2:

Public Member Functions

 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 ()
 
- Public Member Functions inherited from vrpn_Xkeys
 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 void mainloop ()=0
 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().
 
- Public Member Functions inherited from vrpn_BaseClass
 vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL)
 Names the device and assigns or opens connection, calls registration methods.
 
virtual ~vrpn_BaseClass ()
 
- Public Member Functions inherited from vrpn_BaseClassUnique
 vrpn_BaseClassUnique ()
 
virtual ~vrpn_BaseClassUnique ()
 Unregister all of the message handlers that were to be autodeleted.
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using.
 

Protected Member Functions

virtual void setLEDs (LED_STATE red, LED_STATE green)
 
- Protected Member Functions inherited from vrpn_Xkeys
void init_hid ()
 
void on_data_received (size_t bytes, vrpn_uint8 *buffer)
 Derived class reimplements this callback.
 
virtual void decodePacket (size_t bytes, vrpn_uint8 *buffer)=0
 
int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
- Protected Member Functions inherited from vrpn_BaseClass
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.
 
- Protected Member Functions inherited from vrpn_BaseClassUnique
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()
 
- Protected Member Functions inherited from vrpn_HidInterface
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.
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
- Protected Types inherited from vrpn_Xkeys
enum  LED_STATE { Off , On , Flash }
 
- Static Protected Member Functions inherited from vrpn_Xkeys
static int VRPN_CALLBACK on_connect (void *thisPtr, vrpn_HANDLERPARAM p)
 
static int VRPN_CALLBACK on_last_disconnect (void *thisPtr, vrpn_HANDLERPARAM p)
 
- Static Protected Member Functions inherited from vrpn_BaseClassUnique
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.
 
- Protected Attributes inherited from vrpn_Xkeys
struct timeval _timestamp
 
vrpn_HidAcceptor_filter
 
bool _toggle_light
 
- Protected Attributes inherited from vrpn_BaseClassUnique
vrpn_Connectiond_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.
 
- Protected Attributes inherited from vrpn_HidInterface
vrpn_HidAcceptorm_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.
 

Detailed Description

Definition at line 106 of file vrpn_Xkeys.h.

Constructor & Destructor Documentation

◆ vrpn_Xkeys_v2()

vrpn_Xkeys_v2::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 )
inline

◆ ~vrpn_Xkeys_v2()

vrpn_Xkeys_v2::~vrpn_Xkeys_v2 ( )
inline

Definition at line 116 of file vrpn_Xkeys.h.

References vrpn_Xkeys::_toggle_light, vrpn_Xkeys::Off, and setLEDs().

Here is the call graph for this function:

Member Function Documentation

◆ setLEDs()

void vrpn_Xkeys_v2::setLEDs ( LED_STATE red,
LED_STATE green )
protectedvirtual

Implements vrpn_Xkeys.

Definition at line 104 of file vrpn_Xkeys.C.

References vrpn_Xkeys::Flash, vrpn_Xkeys::Off, vrpn_Xkeys::On, and vrpn_HidInterface::send_data().

Referenced by vrpn_Xkeys_v2(), and ~vrpn_Xkeys_v2().

Here is the call graph for this function:

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