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

#include <vrpn_nikon_controls.h>

Inheritance diagram for vrpn_Nikon_Controls:
Collaboration diagram for vrpn_Nikon_Controls:

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.
 
- 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_ConnectionconnectionPtr ()
 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
 

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.
 
- 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.
 

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 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.
 

Protected Attributes

int _status
 
unsigned char _buffer [512]
 
unsigned _bufcount
 
double _requested_focus
 
struct timeval timestamp
 
struct timeval last_poll
 
- 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_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
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 

Detailed Description

Definition at line 13 of file vrpn_nikon_controls.h.

Constructor & Destructor Documentation

◆ vrpn_Nikon_Controls()

◆ ~vrpn_Nikon_Controls()

vrpn_Nikon_Controls::~vrpn_Nikon_Controls ( void )
inline

Definition at line 16 of file vrpn_nikon_controls.h.

Member Function Documentation

◆ get_report()

◆ handle_connect_message()

int vrpn_Nikon_Controls::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 422 of file vrpn_nikon_controls.C.

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

Referenced by vrpn_Nikon_Controls().

Here is the call graph for this function:

◆ handle_request_channels_message()

int vrpn_Nikon_Controls::handle_request_channels_message ( void * userdata,
vrpn_HANDLERPARAM p )
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().

Here is the call graph for this function:

◆ handle_request_message()

int vrpn_Nikon_Controls::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 376 of file vrpn_nikon_controls.C.

References vrpn_HANDLERPARAM::buffer, set_channel(), vrpn_BaseClassUnique::userdata, and vrpn_unbuffer().

Referenced by vrpn_Nikon_Controls().

Here is the call graph for this function:

◆ mainloop()

void vrpn_Nikon_Controls::mainloop ( void )
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().

Here is the call graph for this function:

◆ report()

void vrpn_Nikon_Controls::report ( vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY)
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().

Here is the call graph for this function:

◆ report_changes()

void vrpn_Nikon_Controls::report_changes ( vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY)
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().

Here is the call graph for this function:

◆ reset()

int vrpn_Nikon_Controls::reset ( void )
protectedvirtual

◆ set_channel()

int vrpn_Nikon_Controls::set_channel ( unsigned chan_num,
vrpn_float64 value )
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().

Here is the call graph for this function:

Member Data Documentation

◆ _bufcount

unsigned vrpn_Nikon_Controls::_bufcount
protected

Definition at line 24 of file vrpn_nikon_controls.h.

Referenced by get_report().

◆ _buffer

unsigned char vrpn_Nikon_Controls::_buffer[512]
protected

Definition at line 23 of file vrpn_nikon_controls.h.

Referenced by get_report().

◆ _requested_focus

double vrpn_Nikon_Controls::_requested_focus
protected

Definition at line 26 of file vrpn_nikon_controls.h.

Referenced by get_report(), and set_channel().

◆ _status

int vrpn_Nikon_Controls::_status
protected

Definition at line 21 of file vrpn_nikon_controls.h.

Referenced by vrpn_Nikon_Controls().

◆ last_poll

struct timeval vrpn_Nikon_Controls::last_poll
protected

Definition at line 29 of file vrpn_nikon_controls.h.

Referenced by mainloop(), and vrpn_Nikon_Controls().

◆ timestamp

struct timeval vrpn_Nikon_Controls::timestamp
protected

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