vrpn 07.35
Virtual Reality Peripheral Network
|
#include <vrpn_nikon_controls.h>
Public Member Functions | |
vrpn_Nikon_Controls (const char *device_name, vrpn_Connection *con=NULL, const char *port_name="COM1") | |
~vrpn_Nikon_Controls (void) | |
virtual void | mainloop () |
This routine is called each time through the server's main loop. | |
![]() | |
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 () | |
![]() | |
vrpn_Analog (const char *name, vrpn_Connection *c=NULL) | |
void | print (void) |
vrpn_int32 | getNumChannels (void) const |
![]() | |
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(). | |
![]() | |
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. | |
![]() | |
vrpn_Analog_Output (const char *name, vrpn_Connection *c=NULL) | |
void | o_print (void) |
vrpn_int32 | getNumChannels () const |
Protected Member Functions | |
virtual int | reset (void) |
virtual int | get_report (void) |
virtual int | set_channel (unsigned chan_num, vrpn_float64 value) |
Set the channel associated with the index to the specified value. | |
virtual void | report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY) |
Send changes since the last time. | |
virtual void | report (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY) |
Send values whether or not they have changed. | |
![]() | |
int | read_available_characters (char *buffer, int bytes) |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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_connect_message (void *userdata, vrpn_HANDLERPARAM p) |
Responds to a connection request with a report of the values. | |
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 | 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 | |
int | _status |
unsigned char | _buffer [512] |
unsigned | _bufcount |
double | _requested_focus |
struct timeval | timestamp |
struct timeval | last_poll |
![]() | |
int | serial_fd |
char | portname [1024] |
int | baudrate |
unsigned char | buffer [1024] |
int | bufcounter |
![]() | |
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 |
![]() | |
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. | |
![]() | |
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 |
Additional Inherited Members | |
![]() | |
bool | shutup |
vrpn_MESSAGEHANDLER | handler |
vrpn_int32 | sender |
vrpn_int32 | type |
void * | userdata |
Definition at line 13 of file vrpn_nikon_controls.h.
vrpn_Nikon_Controls::vrpn_Nikon_Controls | ( | const char * | device_name, |
vrpn_Connection * | con = NULL , |
||
const char * | port_name = "COM1" |
||
) |
Definition at line 29 of file vrpn_nikon_controls.C.
References _status, 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(), last_poll, vrpn_Analog::num_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, and STATUS_RESETTING.
|
inline |
Definition at line 16 of file vrpn_nikon_controls.h.
|
protectedvirtual |
Definition at line 217 of file vrpn_nikon_controls.C.
References _bufcount, _buffer, _requested_focus, vrpn_Analog::channel, report_changes(), vrpn_Serial_Analog::serial_fd, vrpn_Analog::status, STATUS_READING, STATUS_RESETTING, STATUS_SYNCING, timestamp, VALID_REPORT_CHARS, vrpn_gettimeofday, VRPN_MSG_ERROR, VRPN_MSG_WARNING, and vrpn_read_available_characters().
Referenced by mainloop().
|
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 422 of file vrpn_nikon_controls.C.
References report(), vrpn_BaseClassUnique::userdata, and vrpn_CONNECTION_RELIABLE.
Referenced by vrpn_Nikon_Controls().
|
staticprotected |
Responds to a request to change multiple channels at once.
Definition at line 394 of file vrpn_nikon_controls.C.
References vrpn_HANDLERPARAM::buffer, vrpn_Analog_Output::o_channel, vrpn_Analog_Output::o_num_channel, vrpn_BaseClassUnique::send_text_message(), set_channel(), timestamp, vrpn_BaseClassUnique::userdata, vrpn_TEXT_ERROR, and vrpn_unbuffer().
Referenced by vrpn_Nikon_Controls().
|
staticprotected |
Responds to a request to change one of the values by setting the channel to that value.
Definition at line 376 of file vrpn_nikon_controls.C.
References vrpn_HANDLERPARAM::buffer, set_channel(), vrpn_BaseClassUnique::userdata, and vrpn_unbuffer().
Referenced by vrpn_Nikon_Controls().
|
virtual |
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 452 of file vrpn_nikon_controls.C.
References get_report(), last_poll, POLL_INTERVAL, reset(), vrpn_Serial_Analog::serial_fd, vrpn_BaseClassUnique::server_mainloop(), vrpn_Analog::status, STATUS_READING, STATUS_RESETTING, STATUS_SYNCING, TIMEOUT_TIME_INTERVAL, timestamp, vrpn_gettimeofday, VRPN_MSG_ERROR, vrpn_TimevalDuration(), and vrpn_write_characters().
|
protectedvirtual |
Send values whether or not they have changed.
Definition at line 437 of file vrpn_nikon_controls.C.
References vrpn_Analog::report(), vrpn_Analog::timestamp, and timestamp.
Referenced by handle_connect_message().
|
protectedvirtual |
Send changes since the last time.
Definition at line 430 of file vrpn_nikon_controls.C.
References vrpn_Analog::report_changes(), vrpn_Analog::timestamp, and timestamp.
Referenced by get_report().
|
protectedvirtual |
Definition at line 150 of file vrpn_nikon_controls.C.
References vrpn_Analog::channel, vrpn_Serial_Analog::serial_fd, vrpn_Analog::status, STATUS_SYNCING, timestamp, vrpn_flush_input_buffer(), vrpn_gettimeofday, VRPN_MSG_WARNING, vrpn_read_available_characters(), vrpn_SleepMsecs(), and vrpn_write_characters().
Referenced by mainloop().
|
protectedvirtual |
Set the channel associated with the index to the specified value.
Channel 0 controls the focus.
Definition at line 343 of file vrpn_nikon_controls.C.
References _requested_focus, vrpn_Analog_Output::o_num_channel, vrpn_Analog_Output::o_timestamp, vrpn_BaseClassUnique::send_text_message(), vrpn_Serial_Analog::serial_fd, vrpn_drain_output_buffer(), vrpn_gettimeofday, vrpn_TEXT_ERROR, and vrpn_write_characters().
Referenced by handle_request_channels_message(), and handle_request_message().
|
protected |
Definition at line 24 of file vrpn_nikon_controls.h.
Referenced by get_report().
|
protected |
Definition at line 23 of file vrpn_nikon_controls.h.
Referenced by get_report().
|
protected |
Definition at line 26 of file vrpn_nikon_controls.h.
Referenced by get_report(), and set_channel().
|
protected |
Definition at line 21 of file vrpn_nikon_controls.h.
Referenced by vrpn_Nikon_Controls().
|
protected |
Definition at line 29 of file vrpn_nikon_controls.h.
Referenced by mainloop(), and vrpn_Nikon_Controls().
|
protected |
Definition at line 28 of file vrpn_nikon_controls.h.
Referenced by get_report(), handle_request_channels_message(), mainloop(), report(), report_changes(), and reset().