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

#include <vrpn_Button.h>

Inheritance diagram for vrpn_Button_Python:
Collaboration diagram for vrpn_Button_Python:

Public Member Functions

 vrpn_Button_Python (const char *name, vrpn_Connection *c, int p)
 
 vrpn_Button_Python (const char *name, vrpn_Connection *c, int p, unsigned ph)
 
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().
 
- Public Member Functions inherited from vrpn_Button_Parallel
 vrpn_Button_Parallel (const char *name, vrpn_Connection *connection, int portno, unsigned porthex=0)
 
 ~vrpn_Button_Parallel ()
 
- 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_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 read (void)
 
- 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 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

bool d_first_fail
 
- Protected Attributes inherited from vrpn_Button_Parallel
int port
 
int status
 
- 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
 
- 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_Button_Filter
vrpn_int32 buttonstate [vrpn_BUTTON_MAX_BUTTONS]
 
- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
- Static Protected Member Functions inherited from vrpn_Button_Filter
static int VRPN_CALLBACK handle_ping_message (void *userdata, 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.
 

Detailed Description

Definition at line 160 of file vrpn_Button.h.

Constructor & Destructor Documentation

◆ vrpn_Button_Python() [1/2]

vrpn_Button_Python::vrpn_Button_Python ( const char * name,
vrpn_Connection * c,
int p )

Definition at line 652 of file vrpn_Button.C.

References d_first_fail, vrpn_Button_Parallel::vrpn_Button_Parallel(), and vrpn_Connection.

Here is the call graph for this function:

◆ vrpn_Button_Python() [2/2]

vrpn_Button_Python::vrpn_Button_Python ( const char * name,
vrpn_Connection * c,
int p,
unsigned ph )

Definition at line 659 of file vrpn_Button.C.

References d_first_fail, vrpn_Button_Parallel::vrpn_Button_Parallel(), and vrpn_Connection.

Here is the call graph for this function:

Member Function Documentation

◆ mainloop()

void vrpn_Button_Python::mainloop ( )
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_BaseClass.

Definition at line 666 of file vrpn_Button.C.

References BUTTON_FAIL, BUTTON_READY, d_first_fail, read(), vrpn_Button_Filter::report_changes(), vrpn_BaseClassUnique::send_text_message(), vrpn_BaseClassUnique::server_mainloop(), vrpn_Button_Parallel::status, vrpn_Button::timestamp, and vrpn_TEXT_ERROR.

Here is the call graph for this function:

◆ read()

void vrpn_Button_Python::read ( void )
protectedvirtual

Member Data Documentation

◆ d_first_fail

bool vrpn_Button_Python::d_first_fail
protected

Definition at line 170 of file vrpn_Button.h.

Referenced by mainloop(), vrpn_Button_Python(), and vrpn_Button_Python().


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