#include <vrpn_GlobalHapticsOrb.h>

Inheritance diagram for vrpn_GlobalHapticsOrb:

[legend]

Collaboration diagram for vrpn_GlobalHapticsOrb:

[legend]

Public Member Functions
	vrpn_GlobalHapticsOrb (const char name, vrpn_Connection c, const char *port, int baud)
	~vrpn_GlobalHapticsOrb ()
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_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 ()
Public Member Functions inherited from vrpn_BaseClassUnique
	vrpn_BaseClassUnique ()
virtual	~vrpn_BaseClassUnique ()
	Unregister all of the message handlers that were to be autodeleted.
vrpn_Connection *	connectionPtr ()
	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)
Public Member Functions inherited from vrpn_Dial
	vrpn_Dial (const char name, vrpn_Connection c=NULL)

Protected Member Functions
virtual void	clear_values (void)
virtual int	reset (void)
virtual int	get_report (void)
virtual void	report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_RELIABLE)
	Send report iff changed.
virtual void	report (vrpn_uint32 class_of_service=vrpn_CONNECTION_RELIABLE)
	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.
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_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_Dial
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, vrpn_int32 buflen, vrpn_int32 dial, vrpn_float64 delta)
virtual void	report_changes (void)
virtual void	report (void)

Static Protected Member Functions
static int VRPN_CALLBACK	handle_firstConnection (void *userdata, vrpn_HANDLERPARAM)
	Clear all of the values when we get our first client connection request.
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)

Protected Attributes
int	d_status
unsigned	d_expected_chars
unsigned char	d_buffer [512]
unsigned	d_bufcount
struct timeval	d_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_Connection *	d_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
Protected Attributes inherited from vrpn_Dial
vrpn_float64	dials [vrpn_DIAL_MAX]
vrpn_int32	num_dials
struct timeval	timestamp
vrpn_int32	change_m_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]

Detailed Description

Definition at line 18 of file vrpn_GlobalHapticsOrb.h.

Constructor & Destructor Documentation

◆ vrpn_GlobalHapticsOrb()

vrpn_GlobalHapticsOrb::vrpn_GlobalHapticsOrb	(	const char *	name,
		vrpn_Connection *	c,
		const char *	port,
		int	baud )

Definition at line 47 of file vrpn_GlobalHapticsOrb.C.

References clear_values(), vrpn_BaseClassUnique::d_connection, d_status, handle_firstConnection(), vrpn_Button::num_buttons, vrpn_Analog::num_channel, vrpn_Dial::num_dials, vrpn_BaseClassUnique::register_autodeleted_handler(), STATUS_RESETTING, vrpn_Button_Filter::vrpn_Button_Filter(), vrpn_Dial::vrpn_Dial(), vrpn_got_first_connection, and vrpn_Serial_Analog::vrpn_Serial_Analog().

Referenced by handle_firstConnection().

Here is the call graph for this function:

◆ ~vrpn_GlobalHapticsOrb()

vrpn_GlobalHapticsOrb::~vrpn_GlobalHapticsOrb ( )

inline

Definition at line 25 of file vrpn_GlobalHapticsOrb.h.

Member Function Documentation

◆ clear_values()

void vrpn_GlobalHapticsOrb::clear_values ( void )

protectedvirtual

Definition at line 71 of file vrpn_GlobalHapticsOrb.C.

References vrpn_Button::buttons, vrpn_Analog::channel, vrpn_Dial::dials, vrpn_Analog::last, vrpn_Button::lastbuttons, vrpn_Button::num_buttons, vrpn_Analog::num_channel, and vrpn_Dial::num_dials.

Referenced by reset(), and vrpn_GlobalHapticsOrb().

◆ get_report()

int vrpn_GlobalHapticsOrb::get_report ( void )

protectedvirtual

Definition at line 152 of file vrpn_GlobalHapticsOrb.C.

References vrpn_Button::buttons, vrpn_Analog::channel, d_bufcount, d_buffer, d_status, d_timestamp, vrpn_Dial::dials, vrpn_Button_Filter::report_changes(), vrpn_BaseClassUnique::send_text_message(), vrpn_Serial_Analog::serial_fd, STATUS_RESETTING, STATUS_SYNCING, vrpn_gettimeofday, vrpn_read_available_characters(), and vrpn_TEXT_ERROR.

Referenced by mainloop().

Here is the call graph for this function:

◆ handle_firstConnection()

int vrpn_GlobalHapticsOrb::handle_firstConnection	(	void *	userdata,
		vrpn_HANDLERPARAM	)

staticprotected

Clear all of the values when we get our first client connection request.

Definition at line 33 of file vrpn_GlobalHapticsOrb.C.

References vrpn_BaseClassUnique::userdata, and vrpn_GlobalHapticsOrb().

Referenced by vrpn_GlobalHapticsOrb().

Here is the call graph for this function:

◆ mainloop()

void vrpn_GlobalHapticsOrb::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 302 of file vrpn_GlobalHapticsOrb.C.

References d_status, d_timestamp, get_report(), POLL_INTERVAL, reset(), vrpn_BaseClassUnique::send_text_message(), vrpn_Serial_Analog::serial_fd, vrpn_BaseClassUnique::server_mainloop(), STATUS_RESETTING, STATUS_SYNCING, vrpn_gettimeofday, vrpn_TEXT_ERROR, vrpn_TimevalDuration(), and vrpn_write_characters().

Here is the call graph for this function:

◆ report()

void vrpn_GlobalHapticsOrb::report ( vrpn_uint32 class_of_service = vrpn_CONNECTION_RELIABLE )

protectedvirtual

Send report whether or not changed.

Definition at line 288 of file vrpn_GlobalHapticsOrb.C.

References d_timestamp, vrpn_Analog::report(), vrpn_Dial::report(), vrpn_Button::report_changes(), vrpn_Analog::timestamp, vrpn_Button::timestamp, and vrpn_Dial::timestamp.

Here is the call graph for this function:

◆ report_changes()

void vrpn_GlobalHapticsOrb::report_changes ( vrpn_uint32 class_of_service = vrpn_CONNECTION_RELIABLE )

protectedvirtual

Send report iff changed.

Definition at line 277 of file vrpn_GlobalHapticsOrb.C.

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

Here is the call graph for this function:

◆ reset()

int vrpn_GlobalHapticsOrb::reset ( void )

protectedvirtual

Definition at line 91 of file vrpn_GlobalHapticsOrb.C.

References clear_values(), d_expected_chars, d_status, d_timestamp, vrpn_BaseClassUnique::send_text_message(), vrpn_Serial_Analog::serial_fd, STATUS_SYNCING, vrpn_flush_input_buffer(), vrpn_gettimeofday, vrpn_read_available_characters(), vrpn_TEXT_ERROR, and vrpn_write_characters().

Referenced by mainloop().

Here is the call graph for this function:

Member Data Documentation

◆ d_bufcount

unsigned vrpn_GlobalHapticsOrb::d_bufcount

protected

Definition at line 36 of file vrpn_GlobalHapticsOrb.h.

Referenced by get_report().

◆ d_buffer

unsigned char vrpn_GlobalHapticsOrb::d_buffer[512]

protected

Definition at line 35 of file vrpn_GlobalHapticsOrb.h.

Referenced by get_report().

◆ d_expected_chars

unsigned vrpn_GlobalHapticsOrb::d_expected_chars

protected

Definition at line 34 of file vrpn_GlobalHapticsOrb.h.

Referenced by reset().

◆ d_status

int vrpn_GlobalHapticsOrb::d_status

protected

Definition at line 32 of file vrpn_GlobalHapticsOrb.h.

Referenced by get_report(), mainloop(), reset(), and vrpn_GlobalHapticsOrb().

◆ d_timestamp

struct timeval vrpn_GlobalHapticsOrb::d_timestamp

protected

Definition at line 38 of file vrpn_GlobalHapticsOrb.h.

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

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ vrpn_GlobalHapticsOrb()

◆ ~vrpn_GlobalHapticsOrb()

Member Function Documentation

◆ clear_values()

◆ get_report()

◆ handle_firstConnection()

◆ mainloop()

◆ report()

◆ report_changes()

◆ reset()

Member Data Documentation

◆ d_bufcount

◆ d_buffer

◆ d_expected_chars

◆ d_status

◆ d_timestamp