vrpn 07.35
Virtual Reality Peripheral Network
|
#include <vrpn_FunctionGenerator.h>
Public Member Functions | |
vrpn_FunctionGenerator_Server (const char *name, vrpn_uint32 numChannels=vrpn_FUNCTION_CHANNELS_MAX, vrpn_Connection *c=NULL) | |
virtual | ~vrpn_FunctionGenerator_Server () |
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(). | |
virtual void | setChannel (vrpn_uint32 channelNum, vrpn_FunctionGenerator_channel *channel)=0 |
virtual void | start ()=0 |
virtual void | stop ()=0 |
virtual void | setSampleRate (vrpn_float32 rate)=0 |
vrpn_uint32 | setNumChannels (vrpn_uint32 numChannels) |
virtual const char * | getInterpreterDescription ()=0 |
![]() | |
vrpn_FunctionGenerator (const char *name, vrpn_Connection *c=NULL) | |
virtual | ~vrpn_FunctionGenerator () |
const vrpn_FunctionGenerator_channel * | getChannel (vrpn_uint32 channelNum) |
vrpn_uint32 | getNumChannels () const |
vrpn_float32 | getSampleRate () |
![]() | |
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. | |
Static Public Member Functions | |
static int VRPN_CALLBACK | handle_channel_message (void *userdata, vrpn_HANDLERPARAM p) |
static int VRPN_CALLBACK | handle_channelRequest_message (void *userdata, vrpn_HANDLERPARAM p) |
static int VRPN_CALLBACK | handle_allChannelRequest_message (void *userdata, vrpn_HANDLERPARAM p) |
static int VRPN_CALLBACK | handle_start_message (void *userdata, vrpn_HANDLERPARAM p) |
static int VRPN_CALLBACK | handle_stop_message (void *userdata, vrpn_HANDLERPARAM p) |
static int VRPN_CALLBACK | handle_sample_rate_message (void *userdata, vrpn_HANDLERPARAM p) |
static int VRPN_CALLBACK | handle_interpreter_request_message (void *userdata, vrpn_HANDLERPARAM p) |
Protected Member Functions | |
int | sendChannelReply (vrpn_uint32 channelNum) |
int | sendSampleRateReply () |
int | sendStartReply (vrpn_bool started) |
int | sendStopReply (vrpn_bool stopped) |
int | sendInterpreterDescription () |
int | sendError (FGError error, vrpn_int32 channel) |
vrpn_int32 | decode_channel (const char *buf, const vrpn_int32 len, vrpn_uint32 &channelNum, vrpn_FunctionGenerator_channel &channel) |
vrpn_int32 | decode_channel_request (const char *buf, const vrpn_int32 len, vrpn_uint32 &channelNum) |
vrpn_int32 | decode_sampleRate_request (const char *buf, const vrpn_int32 len, vrpn_float32 &sampleRate) |
vrpn_int32 | encode_channel_reply (char **buf, vrpn_int32 &len, const vrpn_uint32 channelNum) |
vrpn_int32 | encode_start_reply (char **buf, vrpn_int32 &len, const vrpn_bool isStarted) |
vrpn_int32 | encode_stop_reply (char **buf, vrpn_int32 &len, const vrpn_bool isStopped) |
vrpn_int32 | encode_sampleRate_reply (char **buf, vrpn_int32 &len, const vrpn_float32 sampleRate) |
vrpn_int32 | encode_interpreterDescription_reply (char **buf, vrpn_int32 &len, const char *desc) |
vrpn_int32 | encode_error_report (char **buf, vrpn_int32 &len, const FGError err, const vrpn_int32 channel) |
![]() | |
virtual int | register_types () |
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() | |
Additional Inherited Members | |
![]() | |
enum | FGError { NO_FG_ERROR = 0 , INTERPRETER_ERROR = 1 , TAKING_TOO_LONG = 2 , INVALID_RESULT_QUANTITY = 3 , INVALID_RESULT_RANGE = 4 } |
![]() | |
bool | shutup |
![]() | |
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. | |
![]() | |
vrpn_float32 | sampleRate |
vrpn_uint32 | numChannels |
vrpn_FunctionGenerator_channel * | channels [vrpn_FUNCTION_CHANNELS_MAX] |
vrpn_int32 | channelMessageID |
vrpn_int32 | requestChannelMessageID |
vrpn_int32 | requestAllChannelsMessageID |
vrpn_int32 | sampleRateMessageID |
vrpn_int32 | startFunctionMessageID |
vrpn_int32 | stopFunctionMessageID |
vrpn_int32 | requestInterpreterMessageID |
vrpn_int32 | channelReplyMessageID |
vrpn_int32 | startFunctionReplyMessageID |
vrpn_int32 | stopFunctionReplyMessageID |
vrpn_int32 | sampleRateReplyMessageID |
vrpn_int32 | interpreterReplyMessageID |
vrpn_int32 | errorMessageID |
vrpn_int32 | gotConnectionMessageID |
char | msgbuf [vrpn_CONNECTION_TCP_BUFLEN] |
struct timeval | timestamp |
![]() | |
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 211 of file vrpn_FunctionGenerator.h.
vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server | ( | const char * | name, |
vrpn_uint32 | numChannels = vrpn_FUNCTION_CHANNELS_MAX , |
||
vrpn_Connection * | c = NULL |
||
) |
Definition at line 492 of file vrpn_FunctionGenerator.C.
References vrpn_FunctionGenerator::channelMessageID, vrpn_BaseClassUnique::d_connection, vrpn_BaseClassUnique::d_sender_id, handle_allChannelRequest_message(), handle_channel_message(), handle_channelRequest_message(), handle_interpreter_request_message(), handle_sample_rate_message(), handle_start_message(), handle_stop_message(), vrpn_FunctionGenerator::numChannels, vrpn_BaseClassUnique::register_autodeleted_handler(), vrpn_FunctionGenerator::requestAllChannelsMessageID, vrpn_FunctionGenerator::requestChannelMessageID, vrpn_FunctionGenerator::requestInterpreterMessageID, vrpn_FunctionGenerator::sampleRateMessageID, vrpn_FunctionGenerator::startFunctionMessageID, and vrpn_FunctionGenerator::stopFunctionMessageID.
|
virtual |
Definition at line 556 of file vrpn_FunctionGenerator.C.
|
protected |
Definition at line 1592 of file vrpn_FunctionGenerator.C.
References vrpn_FunctionGenerator_channel::decode_from(), and vrpn_unbuffer().
Referenced by handle_channel_message().
|
protected |
Definition at line 1747 of file vrpn_FunctionGenerator.C.
References vrpn_unbuffer().
Referenced by handle_channelRequest_message().
|
protected |
Definition at line 1805 of file vrpn_FunctionGenerator.C.
References vrpn_FunctionGenerator::sampleRate, and vrpn_unbuffer().
Referenced by handle_sample_rate_message().
|
protected |
Definition at line 1635 of file vrpn_FunctionGenerator.C.
References vrpn_FunctionGenerator::channels, vrpn_buffer(), and vrpn_FUNCTION_CHANNELS_MAX.
Referenced by sendChannelReply().
|
protected |
Definition at line 2034 of file vrpn_FunctionGenerator.C.
References vrpn_buffer().
Referenced by sendError().
|
protected |
Definition at line 1970 of file vrpn_FunctionGenerator.C.
References vrpn_buffer().
Referenced by sendInterpreterDescription().
|
protected |
Definition at line 1923 of file vrpn_FunctionGenerator.C.
References vrpn_FunctionGenerator::sampleRate, and vrpn_buffer().
Referenced by sendSampleRateReply().
|
protected |
Definition at line 1832 of file vrpn_FunctionGenerator.C.
References vrpn_buffer().
Referenced by sendStartReply().
|
protected |
Definition at line 1878 of file vrpn_FunctionGenerator.C.
References vrpn_buffer().
Referenced by sendStopReply().
|
pure virtual |
Referenced by sendInterpreterDescription().
|
static |
Definition at line 644 of file vrpn_FunctionGenerator.C.
References sendChannelReply(), vrpn_BaseClassUnique::userdata, and vrpn_FUNCTION_CHANNELS_MAX.
Referenced by vrpn_FunctionGenerator_Server().
|
static |
Definition at line 582 of file vrpn_FunctionGenerator.C.
References vrpn_HANDLERPARAM::buffer, decode_channel(), vrpn_HANDLERPARAM::payload_len, sendChannelReply(), setChannel(), vrpn_BaseClassUnique::userdata, and vrpn_FUNCTION_CHANNELS_MAX.
Referenced by vrpn_FunctionGenerator_Server().
|
static |
Definition at line 613 of file vrpn_FunctionGenerator.C.
References vrpn_HANDLERPARAM::buffer, decode_channel_request(), vrpn_HANDLERPARAM::payload_len, sendChannelReply(), vrpn_BaseClassUnique::userdata, and vrpn_FUNCTION_CHANNELS_MAX.
Referenced by vrpn_FunctionGenerator_Server().
|
static |
Definition at line 715 of file vrpn_FunctionGenerator.C.
References sendInterpreterDescription(), and vrpn_BaseClassUnique::userdata.
Referenced by vrpn_FunctionGenerator_Server().
|
static |
Definition at line 692 of file vrpn_FunctionGenerator.C.
References vrpn_HANDLERPARAM::buffer, decode_sampleRate_request(), vrpn_HANDLERPARAM::payload_len, sendSampleRateReply(), setSampleRate(), and vrpn_BaseClassUnique::userdata.
Referenced by vrpn_FunctionGenerator_Server().
|
static |
Definition at line 664 of file vrpn_FunctionGenerator.C.
References start(), and vrpn_BaseClassUnique::userdata.
Referenced by vrpn_FunctionGenerator_Server().
|
static |
Definition at line 678 of file vrpn_FunctionGenerator.C.
References stop(), and vrpn_BaseClassUnique::userdata.
Referenced by vrpn_FunctionGenerator_Server().
|
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 573 of file vrpn_FunctionGenerator.C.
References vrpn_BaseClassUnique::server_mainloop().
|
protected |
Definition at line 729 of file vrpn_FunctionGenerator.C.
References vrpn_BaseClassUnique::d_connection, encode_channel_reply(), vrpn_FunctionGenerator::msgbuf, vrpn_Connection::pack_message(), vrpn_FunctionGenerator::timestamp, vrpn_CONNECTION_RELIABLE, vrpn_CONNECTION_TCP_BUFLEN, and vrpn_gettimeofday.
Referenced by handle_allChannelRequest_message(), handle_channel_message(), and handle_channelRequest_message().
|
protected |
Definition at line 894 of file vrpn_FunctionGenerator.C.
References vrpn_BaseClassUnique::d_connection, encode_error_report(), vrpn_FunctionGenerator::msgbuf, vrpn_Connection::pack_message(), vrpn_FunctionGenerator::timestamp, vrpn_CONNECTION_RELIABLE, vrpn_CONNECTION_TCP_BUFLEN, and vrpn_gettimeofday.
|
protected |
Definition at line 861 of file vrpn_FunctionGenerator.C.
References vrpn_BaseClassUnique::d_connection, encode_interpreterDescription_reply(), getInterpreterDescription(), vrpn_FunctionGenerator::msgbuf, vrpn_Connection::pack_message(), vrpn_FunctionGenerator::timestamp, vrpn_CONNECTION_RELIABLE, vrpn_CONNECTION_TCP_BUFLEN, and vrpn_gettimeofday.
Referenced by handle_interpreter_request_message().
|
protected |
Definition at line 762 of file vrpn_FunctionGenerator.C.
References vrpn_BaseClassUnique::d_connection, encode_sampleRate_reply(), vrpn_FunctionGenerator::msgbuf, vrpn_Connection::pack_message(), vrpn_FunctionGenerator::sampleRate, vrpn_FunctionGenerator::timestamp, vrpn_CONNECTION_RELIABLE, vrpn_CONNECTION_TCP_BUFLEN, and vrpn_gettimeofday.
Referenced by handle_sample_rate_message().
|
protected |
Definition at line 795 of file vrpn_FunctionGenerator.C.
References vrpn_BaseClassUnique::d_connection, encode_start_reply(), vrpn_FunctionGenerator::msgbuf, vrpn_Connection::pack_message(), vrpn_FunctionGenerator::timestamp, vrpn_CONNECTION_RELIABLE, vrpn_CONNECTION_TCP_BUFLEN, and vrpn_gettimeofday.
|
protected |
Definition at line 828 of file vrpn_FunctionGenerator.C.
References vrpn_BaseClassUnique::d_connection, encode_stop_reply(), vrpn_FunctionGenerator::msgbuf, vrpn_Connection::pack_message(), vrpn_FunctionGenerator::timestamp, vrpn_CONNECTION_RELIABLE, vrpn_CONNECTION_TCP_BUFLEN, and vrpn_gettimeofday.
|
pure virtual |
Referenced by handle_channel_message().
vrpn_uint32 vrpn_FunctionGenerator_Server::setNumChannels | ( | vrpn_uint32 | numChannels | ) |
Definition at line 563 of file vrpn_FunctionGenerator.C.
References vrpn_FunctionGenerator::numChannels, and vrpn_FUNCTION_CHANNELS_MAX.
|
pure virtual |
Referenced by handle_sample_rate_message().
|
pure virtual |
Referenced by handle_start_message().
|
pure virtual |
Referenced by handle_stop_message().