vrpn 07.35
Virtual Reality Peripheral Network
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vrpn_FunctionGenerator Class Reference

#include <vrpn_FunctionGenerator.h>

Inheritance diagram for vrpn_FunctionGenerator:
Inheritance graph
[legend]
Collaboration diagram for vrpn_FunctionGenerator:
Collaboration graph
[legend]

Public Types

enum  FGError {
  NO_FG_ERROR = 0 , INTERPRETER_ERROR = 1 , TAKING_TOO_LONG = 2 , INVALID_RESULT_QUANTITY = 3 ,
  INVALID_RESULT_RANGE = 4
}
 

Public Member Functions

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

Protected Member Functions

virtual int register_types ()
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
- 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 Attributes

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

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
- 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.
 

Detailed Description

Definition at line 158 of file vrpn_FunctionGenerator.h.

Member Enumeration Documentation

◆ FGError

enum vrpn_FunctionGenerator::FGError
Enumerator
NO_FG_ERROR 
INTERPRETER_ERROR 
TAKING_TOO_LONG 
INVALID_RESULT_QUANTITY 
INVALID_RESULT_RANGE 

Definition at line 173 of file vrpn_FunctionGenerator.h.

Constructor & Destructor Documentation

◆ vrpn_FunctionGenerator()

vrpn_FunctionGenerator::vrpn_FunctionGenerator ( const char * name,
vrpn_Connection * c = NULL )

Definition at line 398 of file vrpn_FunctionGenerator.C.

References channels, vrpn_BaseClass::init(), numChannels, sampleRate, vrpn_BaseClass::vrpn_BaseClass(), and vrpn_FUNCTION_CHANNELS_MAX.

Referenced by vrpn_FunctionGenerator_Remote::vrpn_FunctionGenerator_Remote(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

Here is the call graph for this function:

◆ ~vrpn_FunctionGenerator()

vrpn_FunctionGenerator::~vrpn_FunctionGenerator ( )
virtual

Definition at line 414 of file vrpn_FunctionGenerator.C.

References channels, and vrpn_FUNCTION_CHANNELS_MAX.

Member Function Documentation

◆ getChannel()

const vrpn_FunctionGenerator_channel * vrpn_FunctionGenerator::getChannel ( vrpn_uint32 channelNum)

Definition at line 429 of file vrpn_FunctionGenerator.C.

References channels, and vrpn_FUNCTION_CHANNELS_MAX.

◆ getNumChannels()

vrpn_uint32 vrpn_FunctionGenerator::getNumChannels ( ) const
inline

Definition at line 168 of file vrpn_FunctionGenerator.h.

References numChannels.

◆ getSampleRate()

vrpn_float32 vrpn_FunctionGenerator::getSampleRate ( )
inline

Definition at line 170 of file vrpn_FunctionGenerator.h.

References sampleRate.

◆ register_types()

int vrpn_FunctionGenerator::register_types ( )
protectedvirtual

Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.

Implements vrpn_BaseClass.

Definition at line 438 of file vrpn_FunctionGenerator.C.

References channelMessageID, channelReplyMessageID, vrpn_BaseClassUnique::d_connection, errorMessageID, gotConnectionMessageID, interpreterReplyMessageID, requestAllChannelsMessageID, requestChannelMessageID, requestInterpreterMessageID, sampleRateMessageID, sampleRateReplyMessageID, startFunctionMessageID, startFunctionReplyMessageID, stopFunctionMessageID, stopFunctionReplyMessageID, vrpn_FUNCTION_MESSAGE_TYPE_ALL_CHANNEL_REQUEST, vrpn_FUNCTION_MESSAGE_TYPE_CHANNEL, vrpn_FUNCTION_MESSAGE_TYPE_CHANNEL_REPLY, vrpn_FUNCTION_MESSAGE_TYPE_CHANNEL_REQUEST, vrpn_FUNCTION_MESSAGE_TYPE_ERROR, vrpn_FUNCTION_MESSAGE_TYPE_INTERPRETER_REPLY, vrpn_FUNCTION_MESSAGE_TYPE_INTERPRETER_REQUEST, vrpn_FUNCTION_MESSAGE_TYPE_SAMPLE_RATE, vrpn_FUNCTION_MESSAGE_TYPE_SAMPLE_RATE_REPLY, vrpn_FUNCTION_MESSAGE_TYPE_START, vrpn_FUNCTION_MESSAGE_TYPE_START_REPLY, vrpn_FUNCTION_MESSAGE_TYPE_STOP, vrpn_FUNCTION_MESSAGE_TYPE_STOP_REPLY, and vrpn_got_connection.

Member Data Documentation

◆ channelMessageID

vrpn_int32 vrpn_FunctionGenerator::channelMessageID
protected

Definition at line 187 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

◆ channelReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::channelReplyMessageID
protected

Definition at line 195 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Remote::vrpn_FunctionGenerator_Remote().

◆ channels

vrpn_FunctionGenerator_channel* vrpn_FunctionGenerator::channels[vrpn_FUNCTION_CHANNELS_MAX]
protected

Definition at line 185 of file vrpn_FunctionGenerator.h.

Referenced by vrpn_FunctionGenerator_Remote::decode_channel_reply(), vrpn_FunctionGenerator_Server::encode_channel_reply(), getChannel(), vrpn_FunctionGenerator_Remote::handle_channelReply_message(), vrpn_FunctionGenerator(), and ~vrpn_FunctionGenerator().

◆ errorMessageID

vrpn_int32 vrpn_FunctionGenerator::errorMessageID
protected

Definition at line 200 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Remote::vrpn_FunctionGenerator_Remote().

◆ gotConnectionMessageID

vrpn_int32 vrpn_FunctionGenerator::gotConnectionMessageID
protected

Definition at line 202 of file vrpn_FunctionGenerator.h.

Referenced by register_types().

◆ interpreterReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::interpreterReplyMessageID
protected

Definition at line 199 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Remote::vrpn_FunctionGenerator_Remote().

◆ msgbuf

char vrpn_FunctionGenerator::msgbuf[vrpn_CONNECTION_TCP_BUFLEN]
protected

Definition at line 206 of file vrpn_FunctionGenerator.h.

Referenced by vrpn_FunctionGenerator_Remote::requestAllChannels(), vrpn_FunctionGenerator_Remote::requestChannel(), vrpn_FunctionGenerator_Remote::requestInterpreterDescription(), vrpn_FunctionGenerator_Remote::requestSampleRate(), vrpn_FunctionGenerator_Remote::requestStart(), vrpn_FunctionGenerator_Remote::requestStop(), vrpn_FunctionGenerator_Server::sendChannelReply(), vrpn_FunctionGenerator_Server::sendError(), vrpn_FunctionGenerator_Server::sendInterpreterDescription(), vrpn_FunctionGenerator_Server::sendSampleRateReply(), vrpn_FunctionGenerator_Server::sendStartReply(), vrpn_FunctionGenerator_Server::sendStopReply(), and vrpn_FunctionGenerator_Remote::setChannel().

◆ numChannels

vrpn_uint32 vrpn_FunctionGenerator::numChannels
protected

Definition at line 184 of file vrpn_FunctionGenerator.h.

Referenced by getNumChannels(), vrpn_FunctionGenerator_Server::setNumChannels(), vrpn_FunctionGenerator_Server::setSampleRate(), vrpn_FunctionGenerator(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

◆ requestAllChannelsMessageID

vrpn_int32 vrpn_FunctionGenerator::requestAllChannelsMessageID
protected

Definition at line 189 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

◆ requestChannelMessageID

vrpn_int32 vrpn_FunctionGenerator::requestChannelMessageID
protected

Definition at line 188 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

◆ requestInterpreterMessageID

vrpn_int32 vrpn_FunctionGenerator::requestInterpreterMessageID
protected

Definition at line 193 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

◆ sampleRate

vrpn_float32 vrpn_FunctionGenerator::sampleRate
protected

Definition at line 183 of file vrpn_FunctionGenerator.h.

Referenced by vrpn_FunctionGenerator_Remote::decode_sampleRate_reply(), vrpn_FunctionGenerator_Server::decode_sampleRate_request(), vrpn_FunctionGenerator_Server::encode_sampleRate_reply(), vrpn_FunctionGenerator_Remote::encode_sampleRate_request(), vrpn_FunctionGenerator_Server::getInterpreterDescription(), getSampleRate(), vrpn_FunctionGenerator_Remote::handle_sampleRateReply_message(), vrpn_FunctionGenerator_Server::sendSampleRateReply(), and vrpn_FunctionGenerator().

◆ sampleRateMessageID

vrpn_int32 vrpn_FunctionGenerator::sampleRateMessageID
protected

Definition at line 190 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

◆ sampleRateReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::sampleRateReplyMessageID
protected

Definition at line 198 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Remote::vrpn_FunctionGenerator_Remote().

◆ startFunctionMessageID

vrpn_int32 vrpn_FunctionGenerator::startFunctionMessageID
protected

Definition at line 191 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

◆ startFunctionReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::startFunctionReplyMessageID
protected

Definition at line 196 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Remote::vrpn_FunctionGenerator_Remote().

◆ stopFunctionMessageID

vrpn_int32 vrpn_FunctionGenerator::stopFunctionMessageID
protected

Definition at line 192 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Server::vrpn_FunctionGenerator_Server().

◆ stopFunctionReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::stopFunctionReplyMessageID
protected

Definition at line 197 of file vrpn_FunctionGenerator.h.

Referenced by register_types(), and vrpn_FunctionGenerator_Remote::vrpn_FunctionGenerator_Remote().

◆ timestamp

struct timeval vrpn_FunctionGenerator::timestamp
protected

Definition at line 207 of file vrpn_FunctionGenerator.h.

Referenced by vrpn_FunctionGenerator_Remote::requestAllChannels(), vrpn_FunctionGenerator_Remote::requestChannel(), vrpn_FunctionGenerator_Remote::requestInterpreterDescription(), vrpn_FunctionGenerator_Remote::requestSampleRate(), vrpn_FunctionGenerator_Remote::requestStart(), vrpn_FunctionGenerator_Remote::requestStop(), vrpn_FunctionGenerator_Server::sendChannelReply(), vrpn_FunctionGenerator_Server::sendError(), vrpn_FunctionGenerator_Server::sendInterpreterDescription(), vrpn_FunctionGenerator_Server::sendSampleRateReply(), vrpn_FunctionGenerator_Server::sendStartReply(), vrpn_FunctionGenerator_Server::sendStopReply(), and vrpn_FunctionGenerator_Remote::setChannel().

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