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

#include <vrpn_inertiamouse.h>

Inheritance diagram for vrpn_inertiamouse:
Collaboration diagram for vrpn_inertiamouse:

Public Types

enum  { Channels = 6 , Buttons = 2 , Update_Interval_Hz = 7372800 / 64 / 13 / Channels }

Public Member Functions

 vrpn_inertiamouse (const char *name, vrpn_Connection *c, const char *port, int baud_rate)
 ~vrpn_inertiamouse ()
virtual void mainloop ()
 Called once through each main loop iteration to handle updates.
virtual int reset (void)
Public Member Functions inherited from vrpn_Serial_Analog
 vrpn_Serial_Analog (const char *name, vrpn_Connection *connection, const char *port, int baud=9600, int bits=8, vrpn_SER_PARITY parity=vrpn_SER_PARITY_NONE, bool rts_flow=false)
 ~vrpn_Serial_Analog ()
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.
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.
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)

Static Public Member Functions

static vrpn_inertiamousecreate (const char *name, vrpn_Connection *c, const char *port, int baud_rate)

Static Public Attributes

static const double Vel_Decay = 0.66

Protected Member Functions

virtual void clear_values (void)
virtual int get_report (void)
 Try to read a report from the device. Returns 1 if complete report received, 0 otherwise. Sets _status to match current status.
virtual void report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY)
 send report iff changed
virtual void report (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY)
 send report whether or not changed
Protected Member Functions inherited from vrpn_Serial_Analog
int read_available_characters (char *buffer, int bytes)
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.
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.
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_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.
virtual void report_changes (void)
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.
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.

Protected Attributes

int status_
int numbuttons_
int numchannels_
int expected_chars_
unsigned char buffer_ [512]
int bufcount_
int null_radius_
struct timeval timestamp
double * vel_
dcblocker dcb_ [Channels]
lowpass lp_ [Channels]
Protected Attributes inherited from vrpn_Serial_Analog
int serial_fd
char portname [1024]
int baudrate
unsigned char buffer [1024]
int bufcounter
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_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_Button_Filter
int send_alerts
vrpn_int32 alert_message_id
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

Additional Inherited Members

Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
Public Attributes inherited from vrpn_Button_Filter
vrpn_int32 buttonstate [vrpn_BUTTON_MAX_BUTTONS]
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.
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 94 of file vrpn_inertiamouse.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Channels 
Buttons 
Update_Interval_Hz 

Definition at line 97 of file vrpn_inertiamouse.h.

Constructor & Destructor Documentation

◆ vrpn_inertiamouse()

vrpn_inertiamouse::vrpn_inertiamouse ( const char * name,
vrpn_Connection * c,
const char * port,
int baud_rate )

◆ ~vrpn_inertiamouse()

vrpn_inertiamouse::~vrpn_inertiamouse ( )
inline

Definition at line 117 of file vrpn_inertiamouse.h.

References vel_.

Member Function Documentation

◆ clear_values()

void vrpn_inertiamouse::clear_values ( void )
protectedvirtual

◆ create()

vrpn_inertiamouse * vrpn_inertiamouse::create ( const char * name,
vrpn_Connection * c,
const char * port,
int baud_rate )
static

Definition at line 54 of file vrpn_inertiamouse.C.

References vrpn_inertiamouse().

Here is the call graph for this function:

◆ get_report()

int vrpn_inertiamouse::get_report ( void )
protectedvirtual

Try to read a report from the device. Returns 1 if complete report received, 0 otherwise. Sets _status to match current status.

Definition at line 90 of file vrpn_inertiamouse.C.

References bufcount_, buffer_, vrpn_Button::buttons, vrpn_Analog::channel, Channels, dcb_, expected_chars_, lp_, numchannels_, vrpn_Button_Filter::report_changes(), vrpn_BaseClassUnique::send_text_message(), vrpn_Serial_Analog::serial_fd, status_, STATUS_READING, STATUS_RESETTING, STATUS_SYNCING, timestamp, vel_, vrpn_gettimeofday, vrpn_read_available_characters(), and vrpn_TEXT_ERROR.

Referenced by mainloop().

Here is the call graph for this function:

◆ mainloop()

void vrpn_inertiamouse::mainloop ( void )
virtual

Called once through each main loop iteration to handle updates.

Implements vrpn_BaseClass.

Definition at line 253 of file vrpn_inertiamouse.C.

References get_report(), reset(), vrpn_BaseClassUnique::server_mainloop(), status_, STATUS_READING, STATUS_RESETTING, and STATUS_SYNCING.

Here is the call graph for this function:

◆ report()

void vrpn_inertiamouse::report ( vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY)
protectedvirtual

send report whether or not changed

Definition at line 240 of file vrpn_inertiamouse.C.

References vrpn_Analog::report(), vrpn_Button::report_changes(), vrpn_Analog::timestamp, vrpn_Button::timestamp, and timestamp.

Here is the call graph for this function:

◆ report_changes()

void vrpn_inertiamouse::report_changes ( vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY)
protectedvirtual

send report iff changed

Definition at line 231 of file vrpn_inertiamouse.C.

References vrpn_Analog::report_changes(), vrpn_Button::report_changes(), vrpn_Analog::timestamp, vrpn_Button::timestamp, and timestamp.

Here is the call graph for this function:

◆ reset()

int vrpn_inertiamouse::reset ( void )
virtual

Definition at line 78 of file vrpn_inertiamouse.C.

References clear_values(), vrpn_Serial_Analog::serial_fd, status_, STATUS_SYNCING, timestamp, vrpn_flush_input_buffer(), and vrpn_gettimeofday.

Referenced by mainloop().

Here is the call graph for this function:

Member Data Documentation

◆ bufcount_

int vrpn_inertiamouse::bufcount_
protected

Definition at line 142 of file vrpn_inertiamouse.h.

Referenced by get_report(), and vrpn_inertiamouse().

◆ buffer_

unsigned char vrpn_inertiamouse::buffer_[512]
protected

Definition at line 141 of file vrpn_inertiamouse.h.

Referenced by get_report().

◆ dcb_

dcblocker vrpn_inertiamouse::dcb_[Channels]
protected

Definition at line 151 of file vrpn_inertiamouse.h.

Referenced by get_report(), and vrpn_inertiamouse().

◆ expected_chars_

int vrpn_inertiamouse::expected_chars_
protected

Definition at line 140 of file vrpn_inertiamouse.h.

Referenced by get_report(), and vrpn_inertiamouse().

◆ lp_

lowpass vrpn_inertiamouse::lp_[Channels]
protected

Definition at line 152 of file vrpn_inertiamouse.h.

Referenced by get_report(), and vrpn_inertiamouse().

◆ null_radius_

int vrpn_inertiamouse::null_radius_
protected

Definition at line 144 of file vrpn_inertiamouse.h.

Referenced by vrpn_inertiamouse().

◆ numbuttons_

int vrpn_inertiamouse::numbuttons_
protected

Definition at line 137 of file vrpn_inertiamouse.h.

Referenced by clear_values(), and vrpn_inertiamouse().

◆ numchannels_

int vrpn_inertiamouse::numchannels_
protected

Definition at line 138 of file vrpn_inertiamouse.h.

Referenced by clear_values(), get_report(), and vrpn_inertiamouse().

◆ status_

int vrpn_inertiamouse::status_
protected

Definition at line 136 of file vrpn_inertiamouse.h.

Referenced by get_report(), mainloop(), reset(), and vrpn_inertiamouse().

◆ timestamp

struct timeval vrpn_inertiamouse::timestamp
protected

Definition at line 147 of file vrpn_inertiamouse.h.

Referenced by get_report(), report(), report_changes(), reset(), and vrpn_inertiamouse().

◆ vel_

double* vrpn_inertiamouse::vel_
protected

Definition at line 149 of file vrpn_inertiamouse.h.

Referenced by get_report(), vrpn_inertiamouse(), and ~vrpn_inertiamouse().

◆ Vel_Decay

const double vrpn_inertiamouse::Vel_Decay = 0.66
static

Definition at line 102 of file vrpn_inertiamouse.h.


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