vrpn  07.33
Virtual Reality Peripheral Network
vrpn_FunctionGenerator Class Reference

#include <vrpn_FunctionGenerator.h>

Inheritance diagram for vrpn_FunctionGenerator:
Collaboration diagram for vrpn_FunctionGenerator:

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_channelgetChannel (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. More...
 
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(). More...
 
- Public Member Functions inherited from vrpn_BaseClassUnique
 vrpn_BaseClassUnique ()
 
virtual ~vrpn_BaseClassUnique ()
 Unregister all of the message handlers that were to be autodeleted. More...
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using. More...
 

Protected Member Functions

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

Protected Attributes

vrpn_float32 sampleRate
 
vrpn_uint32 numChannels
 
vrpn_FunctionGenerator_channelchannels [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_Connectiond_connection
 Connection that this object talks to. More...
 
char * d_servicename
 Name of this device, not including the connection part. More...
 
vrpn_int32 d_sender_id
 Sender ID registered with the connection. More...
 
vrpn_int32 d_text_message_id
 ID for text messages. More...
 
vrpn_int32 d_ping_message_id
 Ask the server if they are there. More...
 
vrpn_int32 d_pong_message_id
 Server telling that it is there. More...
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
vrpn_MESSAGEHANDLER handler
 
vrpn_int32 sender
 
vrpn_int32 type
 
void * userdata
 
- 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. More...
 
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. More...
 

Detailed Description

Definition at line 158 of file vrpn_FunctionGenerator.h.

Member Enumeration Documentation

◆ 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 333 of file vrpn_FunctionGenerator.C.

References channels, vrpn_BaseClass::init(), vrpn_FUNCTION_CHANNELS_MAX, and vrpn_FunctionGenerator_channel.

Here is the call graph for this function:

◆ ~vrpn_FunctionGenerator()

vrpn_FunctionGenerator::~vrpn_FunctionGenerator ( )
virtual

Definition at line 349 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 360 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.

◆ getSampleRate()

vrpn_float32 vrpn_FunctionGenerator::getSampleRate ( )
inline

Definition at line 170 of file vrpn_FunctionGenerator.h.

◆ register_types()

Member Data Documentation

◆ channelMessageID

vrpn_int32 vrpn_FunctionGenerator::channelMessageID
protected

◆ channelReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::channelReplyMessageID
protected

◆ channels

◆ errorMessageID

vrpn_int32 vrpn_FunctionGenerator::errorMessageID
protected

◆ 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

◆ msgbuf

◆ numChannels

vrpn_uint32 vrpn_FunctionGenerator::numChannels
protected

◆ requestAllChannelsMessageID

vrpn_int32 vrpn_FunctionGenerator::requestAllChannelsMessageID
protected

◆ requestChannelMessageID

vrpn_int32 vrpn_FunctionGenerator::requestChannelMessageID
protected

◆ requestInterpreterMessageID

vrpn_int32 vrpn_FunctionGenerator::requestInterpreterMessageID
protected

◆ sampleRate

◆ sampleRateMessageID

vrpn_int32 vrpn_FunctionGenerator::sampleRateMessageID
protected

◆ sampleRateReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::sampleRateReplyMessageID
protected

◆ startFunctionMessageID

vrpn_int32 vrpn_FunctionGenerator::startFunctionMessageID
protected

◆ startFunctionReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::startFunctionReplyMessageID
protected

◆ stopFunctionMessageID

vrpn_int32 vrpn_FunctionGenerator::stopFunctionMessageID
protected

◆ stopFunctionReplyMessageID

vrpn_int32 vrpn_FunctionGenerator::stopFunctionReplyMessageID
protected

◆ timestamp


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