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

#include <vrpn_Event_Analog.h>

Inheritance diagram for vrpn_Event_Analog:
Collaboration diagram for vrpn_Event_Analog:

Public Member Functions

 vrpn_Event_Analog (const char *name, vrpn_Connection *connection, const char *evdev_name)
 
 ~vrpn_Event_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 ()
 
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 Types

typedef std::vector< struct vrpn_Event::input_eventevent_vector_t
 
typedef event_vector_t::iterator event_iter_t
 

Protected Member Functions

int read_available_data ()
 
- 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 Attributes

int fd
 
unsigned long max_num_events
 
event_vector_t event_data
 
- 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.
 

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 28 of file vrpn_Event_Analog.h.

Member Typedef Documentation

◆ event_iter_t

typedef event_vector_t::iterator vrpn_Event_Analog::event_iter_t
protected

Definition at line 50 of file vrpn_Event_Analog.h.

◆ event_vector_t

typedef std::vector<struct vrpn_Event::input_event> vrpn_Event_Analog::event_vector_t
protected

Definition at line 49 of file vrpn_Event_Analog.h.

Constructor & Destructor Documentation

◆ vrpn_Event_Analog()

vrpn_Event_Analog::vrpn_Event_Analog ( const char * name,
vrpn_Connection * connection,
const char * evdev_name )

Definition at line 29 of file vrpn_Event_Analog.C.

References fd, vrpn_Analog::status, vrpn_Analog::timestamp, vrpn_ANALOG_FAIL, vrpn_ANALOG_RESETTING, vrpn_gettimeofday, and vrpn_Event::vrpn_open_event().

Here is the call graph for this function:

◆ ~vrpn_Event_Analog()

vrpn_Event_Analog::~vrpn_Event_Analog ( )

Definition at line 74 of file vrpn_Event_Analog.C.

References fd, and vrpn_Event::vrpn_close_event().

Here is the call graph for this function:

Member Function Documentation

◆ read_available_data()

int vrpn_Event_Analog::read_available_data ( )
protected

Definition at line 95 of file vrpn_Event_Analog.C.

References event_data, fd, max_num_events, and vrpn_Event::vrpn_read_event().

Here is the call graph for this function:

Member Data Documentation

◆ event_data

event_vector_t vrpn_Event_Analog::event_data
protected

Definition at line 59 of file vrpn_Event_Analog.h.

Referenced by read_available_data().

◆ fd

int vrpn_Event_Analog::fd
protected

Definition at line 53 of file vrpn_Event_Analog.h.

Referenced by read_available_data(), vrpn_Event_Analog(), and ~vrpn_Event_Analog().

◆ max_num_events

unsigned long vrpn_Event_Analog::max_num_events
protected

Definition at line 56 of file vrpn_Event_Analog.h.

Referenced by read_available_data().


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