#include <vrpn_BiosciencesTools.h>

Inheritance diagram for vrpn_BiosciencesTools:

[legend]

Collaboration diagram for vrpn_BiosciencesTools:

[legend]

Public Member Functions
	vrpn_BiosciencesTools (const char name, vrpn_Connection c, const char *port, float temp1, float temp2, bool control_on)
	~vrpn_BiosciencesTools ()
virtual void	mainloop ()
	Called once through each main loop iteration to handle updates.
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_Analog_Output
	vrpn_Analog_Output (const char name, vrpn_Connection c=NULL)
void	o_print (void)
vrpn_int32	getNumChannels () const
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)

Protected Member Functions
virtual int	reset (void)
virtual int	get_report (void)
bool	set_reference_temperature (unsigned channel, float value)
bool	set_control_status (bool on)
bool	request_temperature (unsigned channel)
bool	set_specified_channel (unsigned channel, vrpn_float64 value)
float	convert_bytes_to_reading (const char *buf)
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_Analog_Output
virtual 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_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.

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.
Static Protected Member Functions inherited from vrpn_Button_Filter
static int VRPN_CALLBACK	handle_ping_message (void *userdata, vrpn_HANDLERPARAM p)

Protected Attributes
char	d_buffer [128]
unsigned	d_bufcount
struct timeval	timestamp
unsigned	d_next_channel_to_read
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_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
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]

Detailed Description

Definition at line 32 of file vrpn_BiosciencesTools.h.

Constructor & Destructor Documentation

◆ vrpn_BiosciencesTools()

vrpn_BiosciencesTools::vrpn_BiosciencesTools	(	const char *	name,
		vrpn_Connection *	c,
		const char *	port,
		float	temp1,
		float	temp2,
		bool	control_on )

Definition at line 58 of file vrpn_BiosciencesTools.C.

References vrpn_Button::buttons, vrpn_BaseClassUnique::d_connection, vrpn_BaseClassUnique::d_ping_message_id, vrpn_BaseClassUnique::d_sender_id, handle_connect_message(), handle_request_channels_message(), handle_request_message(), vrpn_Button::num_buttons, vrpn_Analog::num_channel, vrpn_Analog_Output::o_channel, vrpn_Analog_Output::o_num_channel, vrpn_BaseClassUnique::register_autodeleted_handler(), vrpn_Analog_Output::request_channels_m_id, vrpn_Analog_Output::request_m_id, vrpn_Analog::status, STATUS_RESETTING, vrpn_Analog_Output::vrpn_Analog_Output(), vrpn_Button_Filter::vrpn_Button_Filter(), vrpn_SER_PARITY_NONE, and vrpn_Serial_Analog::vrpn_Serial_Analog().

Referenced by handle_connect_message(), handle_request_channels_message(), and handle_request_message().

Here is the call graph for this function:

◆ ~vrpn_BiosciencesTools()

vrpn_BiosciencesTools::~vrpn_BiosciencesTools ( )

inline

Definition at line 41 of file vrpn_BiosciencesTools.h.

Member Function Documentation

◆ convert_bytes_to_reading()

float vrpn_BiosciencesTools::convert_bytes_to_reading ( const char * buf )

protected

Definition at line 168 of file vrpn_BiosciencesTools.C.

Referenced by get_report().

◆ get_report()

int vrpn_BiosciencesTools::get_report ( void )

protectedvirtual

Definition at line 237 of file vrpn_BiosciencesTools.C.

References vrpn_Analog::channel, convert_bytes_to_reading(), d_bufcount, d_buffer, d_next_channel_to_read, vrpn_Button_Filter::report_changes(), request_temperature(), vrpn_Serial_Analog::serial_fd, vrpn_Analog::status, STATUS_READING, STATUS_RESETTING, STATUS_SYNCING, timestamp, vrpn_gettimeofday, VRPN_MSG_ERROR, and vrpn_read_available_characters().

Referenced by mainloop().

Here is the call graph for this function:

◆ handle_connect_message()

int vrpn_BiosciencesTools::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 414 of file vrpn_BiosciencesTools.C.

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

Referenced by vrpn_BiosciencesTools().

Here is the call graph for this function:

◆ handle_request_channels_message()

int vrpn_BiosciencesTools::handle_request_channels_message	(	void *	userdata,
		vrpn_HANDLERPARAM	p )

staticprotected

Responds to a request to change multiple channels at once.

Definition at line 386 of file vrpn_BiosciencesTools.C.

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

Referenced by vrpn_BiosciencesTools().

Here is the call graph for this function:

◆ handle_request_message()

int vrpn_BiosciencesTools::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 359 of file vrpn_BiosciencesTools.C.

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

Referenced by vrpn_BiosciencesTools().

Here is the call graph for this function:

◆ mainloop()

void vrpn_BiosciencesTools::mainloop ( void )

virtual

Called once through each main loop iteration to handle updates.

This routine is called each time through the server's main loop.

It will take a course of action depending on the current status of the device, either trying to reset it or trying to get a reading from it. It will try to reset the device if no data has come from it for a couple of seconds

Implements vrpn_BaseClass.

Definition at line 443 of file vrpn_BiosciencesTools.C.

References get_report(), reset(), vrpn_BaseClassUnique::server_mainloop(), vrpn_Analog::status, STATUS_READING, STATUS_RESETTING, STATUS_SYNCING, TIMEOUT_TIME_INTERVAL, timestamp, vrpn_gettimeofday, VRPN_MSG_ERROR, and vrpn_TimevalDuration().