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

#include <vrpn_Dial.h>

Inheritance diagram for vrpn_Dial:
Collaboration diagram for vrpn_Dial:

Public Member Functions

 vrpn_Dial (const char *name, vrpn_Connection *c=NULL)
 
- 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 ()
 
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_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 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)
 
- 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 Attributes

vrpn_float64 dials [vrpn_DIAL_MAX]
 
vrpn_int32 num_dials
 
struct timeval timestamp
 
vrpn_int32 change_m_id
 
- 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.
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
- 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.
 

Detailed Description

Definition at line 21 of file vrpn_Dial.h.

Constructor & Destructor Documentation

◆ vrpn_Dial()

vrpn_Dial::vrpn_Dial ( const char * name,
vrpn_Connection * c = NULL )

Member Function Documentation

◆ encode_to()

vrpn_int32 vrpn_Dial::encode_to ( char * buf,
vrpn_int32 buflen,
vrpn_int32 dial,
vrpn_float64 delta )
protectedvirtual

Definition at line 31 of file vrpn_Dial.C.

References vrpn_buffer().

Referenced by report(), and report_changes().

Here is the call graph for this function:

◆ register_types()

int vrpn_Dial::register_types ( void )
protectedvirtual

Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.

Implements vrpn_BaseClass.

Definition at line 18 of file vrpn_Dial.C.

References change_m_id, and vrpn_BaseClassUnique::d_connection.

◆ report()

◆ report_changes()

Member Data Documentation

◆ change_m_id

vrpn_int32 vrpn_Dial::change_m_id
protected

◆ dials

◆ num_dials

vrpn_int32 vrpn_Dial::num_dials
protected

Definition at line 27 of file vrpn_Dial.h.

Referenced by vrpn_GlobalHapticsOrb::clear_values(), vrpn_Futaba_InterLink_Elite::decodePacket(), vrpn_Griffin_PowerMate::decodePacket(), vrpn_Dial_Example_Server::mainloop(), vrpn_CHProducts_Fighterstick_USB::report(), vrpn_Contour_ShuttlePROv2::report(), vrpn_Contour_ShuttleXpress::report(), report(), vrpn_Futaba_InterLink_Elite::report(), vrpn_Griffin_PowerMate::report(), vrpn_Logitech_Extreme_3D_Pro::report(), vrpn_Microsoft_Controller_Raw_Xbox_360_base::report(), vrpn_Microsoft_Controller_Raw_Xbox_S::report(), vrpn_Microsoft_SideWinder::report(), vrpn_Microsoft_SideWinder_Precision_2::report(), vrpn_Saitek_ST290_Pro::report(), vrpn_CHProducts_Fighterstick_USB::report_changes(), vrpn_Contour_ShuttlePROv2::report_changes(), vrpn_Contour_ShuttleXpress::report_changes(), report_changes(), vrpn_Futaba_InterLink_Elite::report_changes(), vrpn_Griffin_PowerMate::report_changes(), vrpn_Logitech_Extreme_3D_Pro::report_changes(), vrpn_Microsoft_Controller_Raw_Xbox_360_base::report_changes(), vrpn_Microsoft_Controller_Raw_Xbox_S::report_changes(), vrpn_Microsoft_SideWinder::report_changes(), vrpn_Microsoft_SideWinder_Precision_2::report_changes(), vrpn_Saitek_ST290_Pro::report_changes(), vrpn_CerealBox::vrpn_CerealBox(), vrpn_CHProducts_Fighterstick_USB::vrpn_CHProducts_Fighterstick_USB(), vrpn_Contour_ShuttlePROv2::vrpn_Contour_ShuttlePROv2(), vrpn_Contour_ShuttleXpress::vrpn_Contour_ShuttleXpress(), vrpn_Dial(), vrpn_Dial_Example_Server::vrpn_Dial_Example_Server(), vrpn_Dial_Remote::vrpn_Dial_Remote(), vrpn_Futaba_InterLink_Elite::vrpn_Futaba_InterLink_Elite(), vrpn_GlobalHapticsOrb::vrpn_GlobalHapticsOrb(), vrpn_Griffin_PowerMate::vrpn_Griffin_PowerMate(), vrpn_ImmersionBox::vrpn_ImmersionBox(), vrpn_Logitech_Extreme_3D_Pro::vrpn_Logitech_Extreme_3D_Pro(), vrpn_Microsoft_Controller_Raw_Xbox_360_base::vrpn_Microsoft_Controller_Raw_Xbox_360_base(), vrpn_Microsoft_Controller_Raw_Xbox_S::vrpn_Microsoft_Controller_Raw_Xbox_S(), vrpn_Microsoft_SideWinder::vrpn_Microsoft_SideWinder(), vrpn_Microsoft_SideWinder_Precision_2::vrpn_Microsoft_SideWinder_Precision_2(), vrpn_raw_SGIBox::vrpn_raw_SGIBox(), vrpn_Saitek_ST290_Pro::vrpn_Saitek_ST290_Pro(), vrpn_Xkeys_Jog_And_Shuttle::vrpn_Xkeys_Jog_And_Shuttle(), vrpn_Xkeys_Jog_And_Shuttle12::vrpn_Xkeys_Jog_And_Shuttle12(), vrpn_Xkeys_Jog_And_Shuttle68::vrpn_Xkeys_Jog_And_Shuttle68(), vrpn_Xkeys_Joystick::vrpn_Xkeys_Joystick(), and vrpn_Xkeys_Joystick12::vrpn_Xkeys_Joystick12().

◆ timestamp

struct timeval vrpn_Dial::timestamp
protected

Definition at line 28 of file vrpn_Dial.h.

Referenced by vrpn_Dial_Example_Server::mainloop(), vrpn_Freespace::mainloop(), vrpn_CerealBox::report(), vrpn_CHProducts_Fighterstick_USB::report(), vrpn_Contour_ShuttlePROv2::report(), vrpn_Contour_ShuttleXpress::report(), report(), vrpn_Futaba_InterLink_Elite::report(), vrpn_GlobalHapticsOrb::report(), vrpn_Griffin_PowerMate::report(), vrpn_ImmersionBox::report(), vrpn_Logitech_Extreme_3D_Pro::report(), vrpn_Microsoft_Controller_Raw_Xbox_360_base::report(), vrpn_Microsoft_Controller_Raw_Xbox_S::report(), vrpn_Microsoft_SideWinder::report(), vrpn_Microsoft_SideWinder_Precision_2::report(), vrpn_Saitek_ST290_Pro::report(), vrpn_Xkeys_Jog_And_Shuttle12::report(), vrpn_Xkeys_Jog_And_Shuttle68::report(), vrpn_Xkeys_Jog_And_Shuttle::report(), vrpn_Xkeys_Joystick12::report(), vrpn_Xkeys_Joystick::report(), vrpn_CerealBox::report_changes(), vrpn_CHProducts_Fighterstick_USB::report_changes(), vrpn_Contour_ShuttlePROv2::report_changes(), vrpn_Contour_ShuttleXpress::report_changes(), report_changes(), vrpn_Futaba_InterLink_Elite::report_changes(), vrpn_GlobalHapticsOrb::report_changes(), vrpn_Griffin_PowerMate::report_changes(), vrpn_ImmersionBox::report_changes(), vrpn_Logitech_Extreme_3D_Pro::report_changes(), vrpn_Microsoft_Controller_Raw_Xbox_360_base::report_changes(), vrpn_Microsoft_Controller_Raw_Xbox_S::report_changes(), vrpn_Microsoft_SideWinder::report_changes(), vrpn_Microsoft_SideWinder_Precision_2::report_changes(), vrpn_Saitek_ST290_Pro::report_changes(), vrpn_Xkeys_Jog_And_Shuttle12::report_changes(), vrpn_Xkeys_Jog_And_Shuttle68::report_changes(), vrpn_Xkeys_Jog_And_Shuttle::report_changes(), vrpn_Xkeys_Joystick12::report_changes(), vrpn_Xkeys_Joystick::report_changes(), vrpn_Dial(), and vrpn_Dial_Remote::vrpn_Dial_Remote().


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