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

Analog server that can scale and clip its range to -1..1. More...

#include <vrpn_Analog.h>

Inheritance diagram for vrpn_Clipping_Analog_Server:
Collaboration diagram for vrpn_Clipping_Analog_Server:

Classes

struct  clipvals_struct
 

Public Member Functions

 vrpn_Clipping_Analog_Server (const char *name, vrpn_Connection *c, vrpn_int32 numChannels=vrpn_CHANNEL_MAX)
 
int setClipValues (int channel, double min, double lowzero, double highzero, double max)
 Set the clipping values for the specified channel. min maps to -1, values between lowzero and highzero map to 0, max maps to 1. Values less than min map to -1, values larger than max map to 1. Default for each channel is -1,0,0,1 It is possible to compress the range to [0..1] by setting the minimum equal to the lowzero. Returns 0 on success, -1 on failure.
 
int setChannelValue (int channel, double value)
 This method should be used to set the value of a channel. It will be scaled and clipped as described in setClipValues. It returns 0 on success and -1 on failure.
 
- Public Member Functions inherited from vrpn_Analog_Server
 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.
 

Protected Attributes

clipvals_struct clipvals [vrpn_CHANNEL_MAX]
 
- 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.
 

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.
 

Detailed Description

Analog server that can scale and clip its range to -1..1.

Definition at line 130 of file vrpn_Analog.h.

Constructor & Destructor Documentation

◆ vrpn_Clipping_Analog_Server()

Member Function Documentation

◆ setChannelValue()

int vrpn_Clipping_Analog_Server::setChannelValue ( int channel,
double value )

◆ setClipValues()

int vrpn_Clipping_Analog_Server::setClipValues ( int channel,
double min,
double lowzero,
double highzero,
double max )

Set the clipping values for the specified channel. min maps to -1, values between lowzero and highzero map to 0, max maps to 1. Values less than min map to -1, values larger than max map to 1. Default for each channel is -1,0,0,1 It is possible to compress the range to [0..1] by setting the minimum equal to the lowzero. Returns 0 on success, -1 on failure.

Definition at line 224 of file vrpn_Analog.C.

References clipvals, vrpn_Clipping_Analog_Server::clipvals_struct::lower_zero, vrpn_Clipping_Analog_Server::clipvals_struct::maximum_val, min, vrpn_Clipping_Analog_Server::clipvals_struct::minimum_val, vrpn_Clipping_Analog_Server::clipvals_struct::upper_zero, and vrpn_CHANNEL_MAX.

Referenced by vrpn_Tracker_Fastrak::add_is900_analog(), and vrpn_Tracker_InterSense::add_is900_analog().

Member Data Documentation

◆ clipvals

clipvals_struct vrpn_Clipping_Analog_Server::clipvals[vrpn_CHANNEL_MAX]
protected

Definition at line 158 of file vrpn_Analog.h.

Referenced by setChannelValue(), setClipValues(), and vrpn_Clipping_Analog_Server().


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