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

#include <vrpn_Analog.h>

Inheritance diagram for vrpn_Analog_Server:
Collaboration diagram for vrpn_Analog_Server:

Public Member Functions

 vrpn_Analog_Server (const char *name, vrpn_Connection *c, vrpn_int32 numChannels=vrpn_CHANNEL_MAX)
virtual void report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY, const struct timeval time=vrpn_ANALOG_NOW)
 Makes public the protected base class function.
virtual void report (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY, const struct timeval time=vrpn_ANALOG_NOW)
 Makes public the protected base class function.
virtual void mainloop ()
 For this server, the user must normally call report() or report_changes() directly. This mainloop() only takes care of the things any server object should do.
vrpn_float64 * channels (void)
 Exposes an array of values for the user to write into.
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.
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.

Additional Inherited Members

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

Detailed Description

Definition at line 95 of file vrpn_Analog.h.

Constructor & Destructor Documentation

◆ vrpn_Analog_Server()

vrpn_Analog_Server::vrpn_Analog_Server ( const char * name,
vrpn_Connection * c,
vrpn_int32 numChannels = vrpn_CHANNEL_MAX )

Member Function Documentation

◆ channels()

vrpn_float64 * vrpn_Analog_Server::channels ( void )
inline

Exposes an array of values for the user to write into.

Definition at line 117 of file vrpn_Analog.h.

References vrpn_Analog::channel.

◆ mainloop()

virtual void vrpn_Analog_Server::mainloop ( void )
inlinevirtual

For this server, the user must normally call report() or report_changes() directly. This mainloop() only takes care of the things any server object should do.

Implements vrpn_BaseClass.

Reimplemented in vrpn_Atmel, vrpn_IMU_Magnetometer, and vrpn_Tracker_PhaseSpace.

Definition at line 114 of file vrpn_Analog.h.

References vrpn_BaseClassUnique::server_mainloop().

Here is the call graph for this function:

◆ report()

void vrpn_Analog_Server::report ( vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY,
const struct timeval time = vrpn_ANALOG_NOW )
virtual

Makes public the protected base class function.

Reimplemented from vrpn_Analog.

Definition at line 188 of file vrpn_Analog.C.

References vrpn_Analog::report().

Referenced by vrpn_IMU_Magnetometer::mainloop().

Here is the call graph for this function:

◆ report_changes()

void vrpn_Analog_Server::report_changes ( vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY,
const struct timeval time = vrpn_ANALOG_NOW )
virtual

Makes public the protected base class function.

Reimplemented from vrpn_Analog.

Definition at line 181 of file vrpn_Analog.C.

References vrpn_Analog::report_changes().

Referenced by vrpn_IMU_Magnetometer::mainloop(), and vrpn_IMU_Magnetometer::vrpn_IMU_Magnetometer().

Here is the call graph for this function:

◆ setNumChannels()

vrpn_int32 vrpn_Analog_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 194 of file vrpn_Analog.C.

References vrpn_Analog::num_channel, and vrpn_CHANNEL_MAX.

Referenced by vrpn_Analog_Server().


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