vrpn  07.33
Virtual Reality Peripheral Network
vrpn_Griffin_PowerMate Class Reference

#include <vrpn_Griffin.h>

Inheritance diagram for vrpn_Griffin_PowerMate:
Collaboration diagram for vrpn_Griffin_PowerMate:

Public Member Functions

 vrpn_Griffin_PowerMate (const char *name, vrpn_Connection *c=0)
 
virtual ~vrpn_Griffin_PowerMate (void)
 
virtual void mainloop (void)
 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(). More...
 
- Public Member Functions inherited from vrpn_Analog
 vrpn_Analog (const char *name, vrpn_Connection *c=NULL)
 
void print (void)
 
vrpn_int32 getNumChannels (void) const
 
- 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. More...
 
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. More...
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using. More...
 
- Public Member Functions inherited from vrpn_Button_Filter
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)
 
- Public Member Functions inherited from vrpn_Button
 vrpn_Button (const char *name, vrpn_Connection *c=NULL)
 
virtual ~vrpn_Button (void)
 
void print (void)
 
- Public Member Functions inherited from vrpn_Dial
 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)
 
- Protected Member Functions inherited from vrpn_Griffin
void init_hid (void)
 
void on_data_received (size_t bytes, vrpn_uint8 *buffer)
 Derived class reimplements this callback. More...
 
int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. More...
 
 vrpn_Griffin (vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c=0)
 
virtual ~vrpn_Griffin (void)
 
- 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. More...
 
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. More...
 
 vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL)
 Names the device and assigns or opens connection, calls registration methods. More...
 
virtual ~vrpn_BaseClass ()
 
- 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. More...
 
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. More...
 
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. More...
 
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() More...
 
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() More...
 
 vrpn_BaseClassUnique ()
 
virtual ~vrpn_BaseClassUnique ()
 Unregister all of the message handlers that were to be autodeleted. More...
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using. More...
 
- 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. More...
 
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) More...
 
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) More...
 
 vrpn_HidInterface (vrpn_HidAcceptor *acceptor)
 
virtual ~vrpn_HidInterface ()
 
virtual bool connected () const
 Returns true iff the last device I/O succeeded. More...
 
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. More...
 
virtual bool reconnect ()
 Tries to reconnect to an acceptable device. Call this if you suspect a hotplug event has occurred. More...
 
vrpn_uint16 vendor () const
 Returns USB vendor ID of connected device. More...
 
vrpn_uint16 product () const
 Returns USB product ID of connected device. More...
 
int interface_number () const
 Returns the USB interface number of connected device. More...
 
- Protected Member Functions inherited from vrpn_Analog
virtual int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. More...
 
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. More...
 
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. More...
 
 vrpn_Analog (const char *name, vrpn_Connection *c=NULL)
 
void print (void)
 
vrpn_int32 getNumChannels (void) const
 
- Protected Member Functions inherited from vrpn_Button_Filter
 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. More...
 
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)
 
- Protected Member Functions inherited from vrpn_Button
virtual int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. More...
 
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. More...
 
 vrpn_Button (const char *name, vrpn_Connection *c=NULL)
 
virtual ~vrpn_Button (void)
 
void print (void)
 
- Protected Member Functions inherited from vrpn_Dial
virtual int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. More...
 
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
 
- Protected Attributes inherited from vrpn_Griffin
struct timeval _timestamp
 
vrpn_HidAcceptor_filter
 
- Protected Attributes inherited from vrpn_BaseClassUnique
vrpn_Connectiond_connection
 Connection that this object talks to. More...
 
char * d_servicename
 Name of this device, not including the connection part. More...
 
vrpn_int32 d_sender_id
 Sender ID registered with the connection. More...
 
vrpn_int32 d_text_message_id
 ID for text messages. More...
 
vrpn_int32 d_ping_message_id
 Ask the server if they are there. More...
 
vrpn_int32 d_pong_message_id
 Server telling that it is there. More...
 
bool shutup
 
vrpn_MESSAGEHANDLER handler
 
vrpn_int32 sender
 
vrpn_int32 type
 
void * userdata
 
- Protected Attributes inherited from vrpn_HidInterface
vrpn_HidAcceptor_acceptor
 This is the HidAcceptor we use when reconnecting. More...
 
bool _working
 
vrpn_uint16 _vendor
 
vrpn_uint16 _product
 
int _interface
 
- Protected Attributes inherited from vrpn_Analog
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
 
- Protected Attributes inherited from vrpn_Button_Filter
int send_alerts
 
vrpn_int32 alert_message_id
 
vrpn_int32 buttonstate [vrpn_BUTTON_MAX_BUTTONS]
 
- Protected Attributes inherited from vrpn_Button
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
 
- Protected Attributes inherited from vrpn_Dial
vrpn_float64 dials [vrpn_DIAL_MAX]
 
vrpn_int32 num_dials
 
struct timeval timestamp
 
vrpn_int32 change_m_id
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
vrpn_MESSAGEHANDLER handler
 
vrpn_int32 sender
 
vrpn_int32 type
 
void * userdata
 
- Public Attributes inherited from vrpn_Button_Filter
vrpn_int32 buttonstate [vrpn_BUTTON_MAX_BUTTONS]
 
- Static Protected Member Functions inherited from vrpn_Griffin
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. More...
 
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. More...
 
- Static Protected Member Functions inherited from vrpn_Button_Filter
static int VRPN_CALLBACK handle_ping_message (void *userdata, vrpn_HANDLERPARAM p)
 

Detailed Description

Definition at line 48 of file vrpn_Griffin.h.

Constructor & Destructor Documentation

◆ vrpn_Griffin_PowerMate()

vrpn_Griffin_PowerMate::vrpn_Griffin_PowerMate ( const char *  name,
vrpn_Connection c = 0 
)

Definition at line 75 of file vrpn_Griffin.C.

◆ ~vrpn_Griffin_PowerMate()

virtual vrpn_Griffin_PowerMate::~vrpn_Griffin_PowerMate ( void  )
inlinevirtual

Definition at line 51 of file vrpn_Griffin.h.

Member Function Documentation

◆ decodePacket()

void vrpn_Griffin_PowerMate::decodePacket ( size_t  bytes,
vrpn_uint8 *  buffer 
)
protectedvirtual

Implements vrpn_Griffin.

Definition at line 174 of file vrpn_Griffin.C.

References vrpn_Dial::dials, and vrpn_Dial::num_dials.

◆ mainloop()

void vrpn_Griffin_PowerMate::mainloop ( void  )
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_Griffin.

Definition at line 93 of file vrpn_Griffin.C.

References vrpn_Griffin::_timestamp, vrpn_BaseClassUnique::server_mainloop(), vrpn_HidInterface::update(), vrpn_gettimeofday, and vrpn_TimevalDuration().

Here is the call graph for this function:

◆ report()

void vrpn_Griffin_PowerMate::report ( vrpn_uint32  class_of_service = vrpn_CONNECTION_LOW_LATENCY)
protected

◆ report_changes()

void vrpn_Griffin_PowerMate::report_changes ( vrpn_uint32  class_of_service = vrpn_CONNECTION_LOW_LATENCY)
protected

Member Data Documentation

◆ _lastDial

vrpn_uint8 vrpn_Griffin_PowerMate::_lastDial
protected

Definition at line 64 of file vrpn_Griffin.h.


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