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

#include <vrpn_LUDL.h>

Inheritance diagram for vrpn_LUDL_USBMAC6000:
Collaboration diagram for vrpn_LUDL_USBMAC6000:

Public Member Functions

 vrpn_LUDL_USBMAC6000 (const char *name, vrpn_Connection *c=0, bool do_recenter=false)
 
virtual ~vrpn_LUDL_USBMAC6000 ()
 
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_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.
 
- Public Member Functions inherited from vrpn_Analog_Output
 vrpn_Analog_Output (const char *name, vrpn_Connection *c=NULL)
 
void o_print (void)
 
vrpn_int32 getNumChannels () const
 

Protected Member Functions

bool check_for_data ()
 
bool interpret_usbmac_ascii_response (const vrpn_uint8 *buffer, int *device_return, int *command_return, int *index_return, int *value_return)
 
void report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_RELIABLE)
 
void report (vrpn_uint32 class_of_service=vrpn_CONNECTION_RELIABLE)
 
int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
- 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.
 
virtual int register_types (void)=0
 Register the types of messages this device sends/receives. 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()
 
virtual int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 

Static Protected Member Functions

static int VRPN_CALLBACK handle_request_message (void *userdata, vrpn_HANDLERPARAM p)
 Responds to a request to change one of the values by setting the channel to that value.
 
static int VRPN_CALLBACK handle_request_channels_message (void *userdata, vrpn_HANDLERPARAM p)
 Responds to a request to change multiple channels at once.
 
static int VRPN_CALLBACK handle_connect_message (void *userdata, vrpn_HANDLERPARAM p)
 Responds to a connection request with a report of the values.
 
- 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.
 

Protected Attributes

struct libusb_context * _context
 
struct libusb_device_handle * _device_handle
 
struct timeval _timestamp
 
unsigned _endpoint
 
vrpn_uint8 _inbuffer [_INBUFFER_SIZE]
 
unsigned _incount
 
- 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_Analog_Output
vrpn_float64 o_channel [vrpn_CHANNEL_MAX]
 
vrpn_int32 o_num_channel
 
struct timeval o_timestamp
 
vrpn_int32 request_m_id
 
vrpn_int32 request_channels_m_id
 
vrpn_int32 report_num_channels_m_id
 
vrpn_int32 got_connection_m_id
 
int o_status
 

Static Protected Attributes

static const unsigned _INBUFFER_SIZE = 1024
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
vrpn_MESSAGEHANDLER handler
 
vrpn_int32 sender
 
vrpn_int32 type
 
void * userdata
 

Detailed Description

Definition at line 38 of file vrpn_LUDL.h.

Constructor & Destructor Documentation

◆ vrpn_LUDL_USBMAC6000()

◆ ~vrpn_LUDL_USBMAC6000()

vrpn_LUDL_USBMAC6000::~vrpn_LUDL_USBMAC6000 ( )
virtual

Definition at line 149 of file vrpn_LUDL.C.

References _context, and _device_handle.

Member Function Documentation

◆ check_for_data()

bool vrpn_LUDL_USBMAC6000::check_for_data ( void  )
protected

Definition at line 171 of file vrpn_LUDL.C.

References _context, _device_handle, _endpoint, _inbuffer, _INBUFFER_SIZE, and _incount.

◆ handle_connect_message()

int vrpn_LUDL_USBMAC6000::handle_connect_message ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

Responds to a connection request with a report of the values.

When we get a connection request from a remote object, send our state so they will know it to start with.

Definition at line 627 of file vrpn_LUDL.C.

References report(), vrpn_BaseClassUnique::userdata, and vrpn_CONNECTION_RELIABLE.

Referenced by vrpn_LUDL_USBMAC6000().

Here is the call graph for this function:

◆ handle_request_channels_message()

int vrpn_LUDL_USBMAC6000::handle_request_channels_message ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

Responds to a request to change multiple channels at once.

Definition at line 599 of file vrpn_LUDL.C.

References vrpn_HANDLERPARAM::buffer, vrpn_Analog_Output::o_channel, vrpn_Analog_Output::o_num_channel, vrpn_BaseClassUnique::send_text_message(), vrpn_Analog::timestamp, vrpn_BaseClassUnique::userdata, vrpn_TEXT_ERROR, and vrpn_unbuffer().

Referenced by vrpn_LUDL_USBMAC6000().

Here is the call graph for this function:

◆ handle_request_message()

int vrpn_LUDL_USBMAC6000::handle_request_message ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

Responds to a request to change one of the values by setting the channel to that value.

Definition at line 572 of file vrpn_LUDL.C.

References vrpn_HANDLERPARAM::buffer, vrpn_Analog_Output::o_num_channel, vrpn_BaseClassUnique::send_text_message(), vrpn_Analog::timestamp, vrpn_BaseClassUnique::userdata, vrpn_TEXT_ERROR, and vrpn_unbuffer().

Referenced by vrpn_LUDL_USBMAC6000().

Here is the call graph for this function:

◆ interpret_usbmac_ascii_response()

bool vrpn_LUDL_USBMAC6000::interpret_usbmac_ascii_response ( const vrpn_uint8 *  buffer,
int *  device_return,
int *  command_return,
int *  index_return,
int *  value_return 
)
protected

Definition at line 323 of file vrpn_LUDL.C.

References REPORT_ERROR.

◆ mainloop()

void vrpn_LUDL_USBMAC6000::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 209 of file vrpn_LUDL.C.

References _context, _device_handle, _timestamp, vrpn_Analog::channel, vrpn_Analog_Output::o_num_channel, report_changes(), vrpn_BaseClassUnique::server_mainloop(), and vrpn_gettimeofday.

Here is the call graph for this function:

◆ register_types()

int vrpn_LUDL_USBMAC6000::register_types ( void  )
inlineprotectedvirtual

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

Reimplemented from vrpn_Analog.

Definition at line 74 of file vrpn_LUDL.h.

◆ report()

void vrpn_LUDL_USBMAC6000::report ( vrpn_uint32  class_of_service = vrpn_CONNECTION_RELIABLE)
protected

Definition at line 257 of file vrpn_LUDL.C.

References _timestamp, vrpn_Analog::report(), and vrpn_Analog::timestamp.

Referenced by handle_connect_message().

Here is the call graph for this function:

◆ report_changes()

void vrpn_LUDL_USBMAC6000::report_changes ( vrpn_uint32  class_of_service = vrpn_CONNECTION_RELIABLE)
protected

Definition at line 263 of file vrpn_LUDL.C.

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

Referenced by mainloop().

Here is the call graph for this function:

Member Data Documentation

◆ _context

struct libusb_context* vrpn_LUDL_USBMAC6000::_context
protected

Definition at line 49 of file vrpn_LUDL.h.

Referenced by check_for_data(), mainloop(), vrpn_LUDL_USBMAC6000(), and ~vrpn_LUDL_USBMAC6000().

◆ _device_handle

struct libusb_device_handle* vrpn_LUDL_USBMAC6000::_device_handle
protected

Definition at line 50 of file vrpn_LUDL.h.

Referenced by check_for_data(), mainloop(), vrpn_LUDL_USBMAC6000(), and ~vrpn_LUDL_USBMAC6000().

◆ _endpoint

unsigned vrpn_LUDL_USBMAC6000::_endpoint
protected

Definition at line 52 of file vrpn_LUDL.h.

Referenced by check_for_data().

◆ _inbuffer

vrpn_uint8 vrpn_LUDL_USBMAC6000::_inbuffer[_INBUFFER_SIZE]
protected

Definition at line 58 of file vrpn_LUDL.h.

Referenced by check_for_data().

◆ _INBUFFER_SIZE

const unsigned vrpn_LUDL_USBMAC6000::_INBUFFER_SIZE = 1024
staticprotected

Definition at line 57 of file vrpn_LUDL.h.

Referenced by check_for_data().

◆ _incount

unsigned vrpn_LUDL_USBMAC6000::_incount
protected

Definition at line 59 of file vrpn_LUDL.h.

Referenced by check_for_data().

◆ _timestamp

struct timeval vrpn_LUDL_USBMAC6000::_timestamp
protected

Definition at line 51 of file vrpn_LUDL.h.

Referenced by mainloop(), report(), and report_changes().


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