vrpn 07.35
Virtual Reality Peripheral Network
|
#include <vrpn_Analog_Output.h>
Public Member Functions | |
vrpn_Analog_Output_Server (const char *name, vrpn_Connection *c, vrpn_int32 numChannels=vrpn_CHANNEL_MAX) | |
virtual | ~vrpn_Analog_Output_Server (void) |
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(). | |
vrpn_int32 | setNumChannels (vrpn_int32 sizeRequested) |
Sets the size of the array; returns the size actually set. (May be clamped to vrpn_CHANNEL_MAX) This should be used before mainloop is ever called. | |
const vrpn_float64 * | o_channels (void) const |
Exposes an array of values for the user to read from. | |
![]() | |
vrpn_Analog_Output (const char *name, vrpn_Connection *c=NULL) | |
void | o_print (void) |
vrpn_int32 | getNumChannels () 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. | |
Protected Member Functions | |
virtual bool | report_num_channels (vrpn_uint32 class_of_service=vrpn_CONNECTION_RELIABLE) |
virtual vrpn_int32 | encode_num_channels_to (char *buf, vrpn_int32 num) |
![]() | |
virtual int | register_types (void) |
Register the types of messages this device sends/receives. Return 0 on success, -1 on fail. | |
![]() | |
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() | |
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. Derived class must either install handlers for this routine or else make its own routines to handle the request message. | |
static int VRPN_CALLBACK | handle_request_channels_message (void *userdata, vrpn_HANDLERPARAM p) |
Responds to a request to change a number of channels Derived class must either install handlers for this routine or else make its own routines to handle the multi-channel request message. | |
static int VRPN_CALLBACK | handle_got_connection (void *userdata, vrpn_HANDLERPARAM p) |
Used to notify us when a new connection is requested, so that we can let the client know how many channels are active. | |
![]() | |
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. | |
Additional Inherited Members | |
![]() | |
bool | shutup |
vrpn_MESSAGEHANDLER | handler |
vrpn_int32 | sender |
vrpn_int32 | type |
void * | userdata |
![]() | |
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 |
![]() | |
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. | |
Definition at line 56 of file vrpn_Analog_Output.h.
vrpn_Analog_Output_Server::vrpn_Analog_Output_Server | ( | const char * | name, |
vrpn_Connection * | c, | ||
vrpn_int32 | numChannels = vrpn_CHANNEL_MAX |
||
) |
Definition at line 52 of file vrpn_Analog_Output.C.
References vrpn_BaseClassUnique::d_connection, vrpn_BaseClassUnique::d_sender_id, vrpn_Analog_Output::got_connection_m_id, handle_got_connection(), handle_request_channels_message(), handle_request_message(), vrpn_BaseClassUnique::register_autodeleted_handler(), vrpn_Analog_Output::request_channels_m_id, vrpn_Analog_Output::request_m_id, and setNumChannels().
|
virtual |
Definition at line 92 of file vrpn_Analog_Output.C.
|
protectedvirtual |
Definition at line 203 of file vrpn_Analog_Output.C.
References vrpn_buffer().
Referenced by report_num_channels().
|
staticprotected |
Used to notify us when a new connection is requested, so that we can let the client know how many channels are active.
Definition at line 174 of file vrpn_Analog_Output.C.
References report_num_channels(), and vrpn_BaseClassUnique::userdata.
Referenced by vrpn_Analog_Output_Server().
|
staticprotected |
Responds to a request to change a number of channels Derived class must either install handlers for this routine or else make its own routines to handle the multi-channel request message.
Definition at line 137 of file vrpn_Analog_Output.C.
References vrpn_HANDLERPARAM::buffer, vrpn_HANDLERPARAM::msg_time, vrpn_Analog_Output::o_channel, vrpn_Analog_Output::o_num_channel, vrpn_BaseClassUnique::send_text_message(), vrpn_BaseClassUnique::userdata, vrpn_TEXT_ERROR, and vrpn_unbuffer().
Referenced by vrpn_Analog_Output_Server().
|
staticprotected |
Responds to a request to change one of the values by setting the channel to that value. Derived class must either install handlers for this routine or else make its own routines to handle the request message.
Definition at line 105 of file vrpn_Analog_Output.C.
References vrpn_HANDLERPARAM::buffer, vrpn_HANDLERPARAM::msg_time, vrpn_Analog_Output::o_channel, vrpn_Analog_Output::o_num_channel, vrpn_BaseClassUnique::send_text_message(), vrpn_BaseClassUnique::userdata, vrpn_TEXT_ERROR, and vrpn_unbuffer().
Referenced by vrpn_Analog_Output_Server().
|
inlinevirtual |
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.
Reimplemented in vrpn_Atmel.
Definition at line 62 of file vrpn_Analog_Output.h.
References vrpn_BaseClassUnique::server_mainloop().
|
inline |
Exposes an array of values for the user to read from.
Definition at line 70 of file vrpn_Analog_Output.h.
Referenced by vrpn_Analog_Output_Callback_Server::handle_change_message().
|
protectedvirtual |
Definition at line 184 of file vrpn_Analog_Output.C.
References vrpn_BaseClassUnique::d_connection, vrpn_BaseClassUnique::d_sender_id, encode_num_channels_to(), vrpn_Analog_Output::o_num_channel, vrpn_Analog_Output::o_timestamp, vrpn_Connection::pack_message(), vrpn_Analog_Output::report_num_channels_m_id, and vrpn_gettimeofday.
Referenced by handle_got_connection().
vrpn_int32 vrpn_Analog_Output_Server::setNumChannels | ( | vrpn_int32 | sizeRequested | ) |
Sets the size of the array; returns the size actually set. (May be clamped to vrpn_CHANNEL_MAX) This should be used before mainloop is ever called.
Definition at line 94 of file vrpn_Analog_Output.C.
References vrpn_Analog_Output::o_num_channel, and vrpn_CHANNEL_MAX.
Referenced by vrpn_Analog_Output_Server().