vrpn  07.33
Virtual Reality Peripheral Network
vrpn_Tracker_Liberty Class Reference

#include <vrpn_Tracker_Liberty.h>

Inheritance diagram for vrpn_Tracker_Liberty:
Collaboration diagram for vrpn_Tracker_Liberty:

Public Member Functions

 vrpn_Tracker_Liberty (const char *name, vrpn_Connection *c, const char *port="/dev/ttyS0", long baud=115200, int enable_filtering=1, int numstations=vrpn_LIBERTY_MAX_STATIONS, const char *additional_reset_commands=NULL, int whoamilen=195)
 The constructor is given the name of the tracker (the name of the sender it should use), the connection on which it is to send its messages, the name of the serial port it is to open (default is /dev/ttyS0 (first serial port in Linux)), the baud rate at which it is to communicate (default 19200), whether filtering is enabled (default yes), and the number of stations that are possible on this Liberty (default 4). The station select switches on the front of the Liberty determine which stations are active. The final parameter is a string that can contain additional commands that are set to the tracker as part of its reset routine. These might be used to set the hemisphere or other things that are not normally included; see the Liberty manual for a list of these. There can be multiple lines of them but putting <CR> into the string. More...
 
 ~vrpn_Tracker_Liberty ()
 
int add_stylus_button (const char *button_device_name, int sensor, int numbuttons=1)
 Add a stylus (with button) to one of the sensors. More...
 
- Public Member Functions inherited from vrpn_Tracker_Serial
 vrpn_Tracker_Serial (const char *name, vrpn_Connection *c, const char *port="/dev/ttyS1", long baud=38400)
 
virtual ~vrpn_Tracker_Serial ()
 
virtual void mainloop ()
 Uses the get_report, send_report, and reset routines to implement a server. More...
 
- Public Member Functions inherited from vrpn_Tracker
 vrpn_Tracker (const char *name, vrpn_Connection *c=NULL, const char *tracker_cfg_file_name=NULL)
 
virtual ~vrpn_Tracker (void)
 
int read_config_file (FILE *config_file, const char *tracker_name)
 
void print_latest_report (void)
 
int register_server_handlers (void)
 
void get_local_t2r (vrpn_float64 *vec, vrpn_float64 *quat)
 
void get_local_u2s (vrpn_int32 sensor, vrpn_float64 *vec, vrpn_float64 *quat)
 
- 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. More...
 
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. More...
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using. More...
 

Protected Member Functions

virtual int get_report (void)
 Gets a report if one is available, returns 0 if not, 1 if complete report. More...
 
virtual void reset ()
 Reset the tracker. More...
 
int set_sensor_output_format (int sensor)
 Augments the basic Liberty format. More...
 
int report_length (int sensor)
 Augments the basic Liberty report length. More...
 
- Protected Member Functions inherited from vrpn_Tracker_Serial
virtual void send_report (void)
 
- Protected Member Functions inherited from vrpn_Tracker
bool ensure_enough_unit2sensors (unsigned num)
 
virtual int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. More...
 
virtual int encode_to (char *buf)
 
virtual int encode_vel_to (char *buf)
 
virtual int encode_acc_to (char *buf)
 
virtual int encode_tracker2room_to (char *buf)
 Encodes the "Tracker to Room" transformation into the buffer specified. More...
 
virtual int encode_unit2sensor_to (char *buf)
 Encodes the "Unit to Sensor" transformation into the buffer specified. More...
 
virtual int encode_workspace_to (char *buf)
 
- 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. More...
 
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. More...
 
- 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. More...
 
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. More...
 
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. More...
 
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() More...
 
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() More...
 

Protected Attributes

struct timeval reset_time
 
int do_filter
 
int num_stations
 
int num_resets
 
char add_reset_cmd [2048]
 
int whoami_len
 
int got_single_sync_char
 
struct timeval liberty_zerotime
 
struct timeval liberty_timestamp
 
vrpn_uint32 REPORT_LEN
 
vrpn_Button_Serverstylus_buttons [vrpn_LIBERTY_MAX_STATIONS]
 
- Protected Attributes inherited from vrpn_Tracker_Serial
char portname [VRPN_TRACKER_BUF_SIZE]
 
long baudrate
 
int serial_fd
 
unsigned char buffer [VRPN_TRACKER_BUF_SIZE]
 
vrpn_uint32 bufcount
 
- Protected Attributes inherited from vrpn_Tracker
vrpn_int32 position_m_id
 
vrpn_int32 velocity_m_id
 
vrpn_int32 accel_m_id
 
vrpn_int32 tracker2room_m_id
 
vrpn_int32 unit2sensor_m_id
 
vrpn_int32 request_t2r_m_id
 
vrpn_int32 request_u2s_m_id
 
vrpn_int32 request_workspace_m_id
 
vrpn_int32 workspace_m_id
 
vrpn_int32 update_rate_id
 
vrpn_int32 connection_dropped_m_id
 
vrpn_int32 reset_origin_m_id
 
vrpn_int32 d_sensor
 
vrpn_float64 pos [3]
 
vrpn_float64 d_quat [4]
 
vrpn_float64 vel [3]
 
vrpn_float64 vel_quat [4]
 
vrpn_float64 vel_quat_dt
 
vrpn_float64 acc [3]
 
vrpn_float64 acc_quat [4]
 
vrpn_float64 acc_quat_dt
 
struct timeval timestamp
 
vrpn_int32 frame_count
 
struct timeval watchdog_timestamp
 
vrpn_float64 tracker2room [3]
 
vrpn_float64 tracker2room_quat [4]
 
vrpn_int32 num_sensors
 
vrpn_Tracker_Posunit2sensor
 
vrpn_Tracker_Quatunit2sensor_quat
 
unsigned num_unit2sensors
 
vrpn_float64 workspace_min [3]
 
vrpn_float64 workspace_max [3]
 
int status
 
- Protected Attributes inherited from vrpn_BaseClassUnique
vrpn_Connectiond_connection
 Connection that this object talks to. More...
 
char * d_servicename
 Name of this device, not including the connection part. More...
 
vrpn_int32 d_sender_id
 Sender ID registered with the connection. More...
 
vrpn_int32 d_text_message_id
 ID for text messages. More...
 
vrpn_int32 d_ping_message_id
 Ask the server if they are there. More...
 
vrpn_int32 d_pong_message_id
 Server telling that it is there. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from vrpn_Tracker
static int VRPN_CALLBACK handle_t2r_request (void *userdata, vrpn_HANDLERPARAM p)
 
static int VRPN_CALLBACK handle_u2s_request (void *userdata, vrpn_HANDLERPARAM p)
 
static int VRPN_CALLBACK handle_workspace_request (void *userdata, vrpn_HANDLERPARAM p)
 
- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
vrpn_MESSAGEHANDLER handler
 
vrpn_int32 sender
 
vrpn_int32 type
 
void * userdata
 
- 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. More...
 
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. More...
 

Detailed Description

Definition at line 24 of file vrpn_Tracker_Liberty.h.

Constructor & Destructor Documentation

◆ vrpn_Tracker_Liberty()

vrpn_Tracker_Liberty::vrpn_Tracker_Liberty ( const char *  name,
vrpn_Connection c,
const char *  port = "/dev/ttyS0",
long  baud = 115200,
int  enable_filtering = 1,
int  numstations = vrpn_LIBERTY_MAX_STATIONS,
const char *  additional_reset_commands = NULL,
int  whoamilen = 195 
)

The constructor is given the name of the tracker (the name of the sender it should use), the connection on which it is to send its messages, the name of the serial port it is to open (default is /dev/ttyS0 (first serial port in Linux)), the baud rate at which it is to communicate (default 19200), whether filtering is enabled (default yes), and the number of stations that are possible on this Liberty (default 4). The station select switches on the front of the Liberty determine which stations are active. The final parameter is a string that can contain additional commands that are set to the tracker as part of its reset routine. These might be used to set the hemisphere or other things that are not normally included; see the Liberty manual for a list of these. There can be multiple lines of them but putting <CR> into the string.

Definition at line 26 of file vrpn_Tracker_Liberty.C.

References add_reset_cmd, DEBUG, num_stations, reset_time, and stylus_buttons.

◆ ~vrpn_Tracker_Liberty()

vrpn_Tracker_Liberty::~vrpn_Tracker_Liberty ( )

Definition at line 54 of file vrpn_Tracker_Liberty.C.

Member Function Documentation

◆ add_stylus_button()

int vrpn_Tracker_Liberty::add_stylus_button ( const char *  button_device_name,
int  sensor,
int  numbuttons = 1 
)

Add a stylus (with button) to one of the sensors.

Definition at line 688 of file vrpn_Tracker_Liberty.C.

References vrpn_BaseClassUnique::d_connection, num_stations, set_sensor_output_format(), stylus_buttons, vrpn_Button_Server, and VRPN_MSG_ERROR.

Here is the call graph for this function:

◆ get_report()

◆ report_length()

int vrpn_Tracker_Liberty::report_length ( int  sensor)
protected

Augments the basic Liberty report length.

This routine augments the standard Liberty report (3 initial characters + 3*4 for position + 4*4 for quaternions) to include the timestamp for the given sensor.

It returns the number of characters total to expect for a report for the given sensor.

Definition at line 110 of file vrpn_Tracker_Liberty.C.

References stylus_buttons.

Referenced by get_report().

◆ reset()

◆ set_sensor_output_format()

int vrpn_Tracker_Liberty::set_sensor_output_format ( int  sensor)
protected

Augments the basic Liberty format.

This routine augments the basic sensor-output setting function of the Liberty It sets the device for position + quaternion + any of the extended fields. It puts a space at the end so that we can check to make sure we have complete good records for each report.

Returns 0 on success and -1 on failure.

Definition at line 67 of file vrpn_Tracker_Liberty.C.

References DEBUG, vrpn_Tracker_Serial::serial_fd, vrpn_Tracker::status, stylus_buttons, VRPN_MSG_ERROR, vrpn_SleepMsecs(), vrpn_TRACKER_FAIL, and vrpn_write_characters().

Referenced by add_stylus_button(), and reset().

Here is the call graph for this function:

Member Data Documentation

◆ add_reset_cmd

char vrpn_Tracker_Liberty::add_reset_cmd[2048]
protected

Definition at line 61 of file vrpn_Tracker_Liberty.h.

Referenced by reset(), and vrpn_Tracker_Liberty().

◆ do_filter

int vrpn_Tracker_Liberty::do_filter
protected

Definition at line 58 of file vrpn_Tracker_Liberty.h.

Referenced by reset().

◆ got_single_sync_char

int vrpn_Tracker_Liberty::got_single_sync_char
protected

Definition at line 63 of file vrpn_Tracker_Liberty.h.

Referenced by get_report().

◆ liberty_timestamp

struct timeval vrpn_Tracker_Liberty::liberty_timestamp
protected

Definition at line 63 of file vrpn_Tracker_Liberty.h.

◆ liberty_zerotime

struct timeval vrpn_Tracker_Liberty::liberty_zerotime
protected

Definition at line 63 of file vrpn_Tracker_Liberty.h.

Referenced by get_report(), and reset().

◆ num_resets

int vrpn_Tracker_Liberty::num_resets
protected

Definition at line 60 of file vrpn_Tracker_Liberty.h.

Referenced by reset().

◆ num_stations

int vrpn_Tracker_Liberty::num_stations
protected

Definition at line 59 of file vrpn_Tracker_Liberty.h.

Referenced by add_stylus_button(), get_report(), reset(), and vrpn_Tracker_Liberty().

◆ REPORT_LEN

vrpn_uint32 vrpn_Tracker_Liberty::REPORT_LEN
protected

Definition at line 67 of file vrpn_Tracker_Liberty.h.

Referenced by get_report().

◆ reset_time

struct timeval vrpn_Tracker_Liberty::reset_time
protected

Definition at line 55 of file vrpn_Tracker_Liberty.h.

Referenced by vrpn_Tracker_Liberty().

◆ stylus_buttons

vrpn_Button_Server* vrpn_Tracker_Liberty::stylus_buttons[vrpn_LIBERTY_MAX_STATIONS]
protected

◆ whoami_len

int vrpn_Tracker_Liberty::whoami_len
protected

Definition at line 62 of file vrpn_Tracker_Liberty.h.

Referenced by reset().


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