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

#include <vrpn_Magellan.h>

Inheritance diagram for vrpn_Magellan:
Collaboration diagram for vrpn_Magellan:

Public Member Functions

 vrpn_Magellan (const char *name, vrpn_Connection *c, const char *port, int baud, bool altreset=false)
 
 ~vrpn_Magellan ()
 
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 ()
 
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_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)
 
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)
 

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.
 
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()
 
- 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_changes (void)
 
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.
 
virtual vrpn_int32 encode_states_to (char *buf)
 Encode a message describing the state of all buttons.
 

Protected Attributes

bool _altreset
 
int _status
 
int _numbuttons
 
int _numchannels
 
unsigned _expected_chars
 
unsigned char _buffer [512]
 
unsigned _bufcount
 
int _null_radius
 
struct timeval timestamp
 
- 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 11 of file vrpn_Magellan.h.

Constructor & Destructor Documentation

◆ vrpn_Magellan()

vrpn_Magellan::vrpn_Magellan ( const char *  name,
vrpn_Connection c,
const char *  port,
int  baud,
bool  altreset = false 
)

◆ ~vrpn_Magellan()

vrpn_Magellan::~vrpn_Magellan ( )
inline

Definition at line 18 of file vrpn_Magellan.h.

Member Function Documentation

◆ clear_values()

void vrpn_Magellan::clear_values ( void  )
protectedvirtual

◆ get_report()

int vrpn_Magellan::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 178 of file vrpn_Magellan.C.

References _bufcount, _buffer, _expected_chars, _null_radius, _numchannels, vrpn_Button::buttons, vrpn_Analog::channel, vrpn_Button_Filter::report_changes(), vrpn_BaseClassUnique::send_text_message(), vrpn_Serial_Analog::serial_fd, vrpn_Analog::status, STATUS_READING, STATUS_RESETTING, STATUS_SYNCING, timestamp, vrpn_gettimeofday, vrpn_read_available_characters(), and vrpn_TEXT_ERROR.

Referenced by mainloop().

Here is the call graph for this function:

◆ mainloop()

void vrpn_Magellan::mainloop ( void  )
virtual

Called once through each main loop iteration to handle updates.

Implements vrpn_BaseClass.

Definition at line 412 of file vrpn_Magellan.C.

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

Here is the call graph for this function:

◆ report()

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

send report whether or not changed

Definition at line 400 of file vrpn_Magellan.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_Magellan::report_changes ( vrpn_uint32  class_of_service = vrpn_CONNECTION_LOW_LATENCY)
protectedvirtual

send report iff changed

Definition at line 391 of file vrpn_Magellan.C.

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

Here is the call graph for this function:

◆ reset()

Member Data Documentation

◆ _altreset

bool vrpn_Magellan::_altreset
protected

Definition at line 26 of file vrpn_Magellan.h.

Referenced by reset().

◆ _bufcount

unsigned vrpn_Magellan::_bufcount
protected

Definition at line 33 of file vrpn_Magellan.h.

Referenced by get_report(), and vrpn_Magellan().

◆ _buffer

unsigned char vrpn_Magellan::_buffer[512]
protected

Definition at line 32 of file vrpn_Magellan.h.

Referenced by get_report().

◆ _expected_chars

unsigned vrpn_Magellan::_expected_chars
protected

Definition at line 31 of file vrpn_Magellan.h.

Referenced by get_report().

◆ _null_radius

int vrpn_Magellan::_null_radius
protected

Definition at line 35 of file vrpn_Magellan.h.

Referenced by get_report(), and reset().

◆ _numbuttons

int vrpn_Magellan::_numbuttons
protected

Definition at line 28 of file vrpn_Magellan.h.

Referenced by clear_values(), and vrpn_Magellan().

◆ _numchannels

int vrpn_Magellan::_numchannels
protected

Definition at line 29 of file vrpn_Magellan.h.

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

◆ _status

int vrpn_Magellan::_status
protected

Definition at line 27 of file vrpn_Magellan.h.

Referenced by vrpn_Magellan().

◆ timestamp

struct timeval vrpn_Magellan::timestamp
protected

Definition at line 37 of file vrpn_Magellan.h.

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


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