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

#include <vrpn_NationalInstruments.h>

Inheritance diagram for vrpn_Analog_Output_Server_NI:
Collaboration diagram for vrpn_Analog_Output_Server_NI:

Public Member Functions

 vrpn_Analog_Output_Server_NI (const char *name, vrpn_Connection *c, const char *boardName="PCI-6713", vrpn_int16 numChannels=vrpn_CHANNEL_MAX, bool bipolar=false, double minVoltage=0.0, double maxVoltage=10.0)
 
virtual ~vrpn_Analog_Output_Server_NI (void)
 
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().
 
- Public Member Functions inherited from vrpn_Analog_Output
 vrpn_Analog_Output (const char *name, vrpn_Connection *c=NULL)
 
void o_print (void)
 
vrpn_int32 getNumChannels () 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 Member Functions

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.
 
virtual bool report_num_channels (vrpn_uint32 class_of_service=vrpn_CONNECTION_RELIABLE)
 
virtual vrpn_int32 encode_num_channels_to (char *buf, vrpn_int32 num)
 
- Protected Member Functions inherited from vrpn_Analog_Output
virtual int register_types (void)
 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()
 

Static Protected Member Functions

static int VRPN_CALLBACK handle_request_message (void *userdata, vrpn_HANDLERPARAM p)
 Responds to a request to change one of the values by setting the channel to that value. Derived class must either install handlers for this routine or else make its own routines to handle the request message.
 
static int VRPN_CALLBACK handle_request_channels_message (void *userdata, vrpn_HANDLERPARAM p)
 Responds to a request to change a number of channels Derived class must either install handlers for this routine or else make its own routines to handle the multi-channel request message.
 
static int VRPN_CALLBACK handle_got_connection (void *userdata, vrpn_HANDLERPARAM p)
 Used to notify us when a new connection is requested, so that we can let the client know how many channels are active.
 
- 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

short NI_device_number
 
short NI_num_channels
 
double min_voltage
 
double max_voltage
 
short polarity
 
- Protected Attributes inherited from vrpn_Analog_Output
vrpn_float64 o_channel [vrpn_CHANNEL_MAX]
 
vrpn_int32 o_num_channel
 
struct timeval o_timestamp
 
vrpn_int32 request_m_id
 
vrpn_int32 request_channels_m_id
 
vrpn_int32 report_num_channels_m_id
 
vrpn_int32 got_connection_m_id
 
int o_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
 

Detailed Description

Definition at line 103 of file vrpn_NationalInstruments.h.

Constructor & Destructor Documentation

◆ vrpn_Analog_Output_Server_NI()

vrpn_Analog_Output_Server_NI::vrpn_Analog_Output_Server_NI ( const char *  name,
vrpn_Connection c,
const char *  boardName = "PCI-6713",
vrpn_int16  numChannels = vrpn_CHANNEL_MAX,
bool  bipolar = false,
double  minVoltage = 0.0,
double  maxVoltage = 10.0 
)

◆ ~vrpn_Analog_Output_Server_NI()

vrpn_Analog_Output_Server_NI::~vrpn_Analog_Output_Server_NI ( void  )
virtual

Definition at line 603 of file vrpn_NationalInstruments.C.

Member Function Documentation

◆ encode_num_channels_to()

vrpn_int32 vrpn_Analog_Output_Server_NI::encode_num_channels_to ( char *  buf,
vrpn_int32  num 
)
protectedvirtual

Definition at line 757 of file vrpn_NationalInstruments.C.

References vrpn_buffer().

Referenced by report_num_channels().

Here is the call graph for this function:

◆ handle_got_connection()

int VRPN_CALLBACK vrpn_Analog_Output_Server_NI::handle_got_connection ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

Used to notify us when a new connection is requested, so that we can let the client know how many channels are active.

Definition at line 728 of file vrpn_NationalInstruments.C.

References report_num_channels(), and vrpn_BaseClassUnique::userdata.

Referenced by vrpn_Analog_Output_Server_NI().

Here is the call graph for this function:

◆ handle_request_channels_message()

int vrpn_Analog_Output_Server_NI::handle_request_channels_message ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

Responds to a request to change a number of channels Derived class must either install handlers for this routine or else make its own routines to handle the multi-channel request message.

Definition at line 669 of file vrpn_NationalInstruments.C.

References vrpn_HANDLERPARAM::buffer, max_voltage, min_voltage, vrpn_HANDLERPARAM::msg_time, NI_device_number, vrpn_Analog_Output::o_channel, vrpn_Analog_Output::o_num_channel, vrpn_BaseClassUnique::send_text_message(), vrpn_BaseClassUnique::userdata, vrpn_TEXT_ERROR, vrpn_TEXT_WARNING, and vrpn_unbuffer().

Referenced by vrpn_Analog_Output_Server_NI().

Here is the call graph for this function:

◆ handle_request_message()

int VRPN_CALLBACK vrpn_Analog_Output_Server_NI::handle_request_message ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

Responds to a request to change one of the values by setting the channel to that value. Derived class must either install handlers for this routine or else make its own routines to handle the request message.

Definition at line 622 of file vrpn_NationalInstruments.C.

References vrpn_HANDLERPARAM::buffer, max_voltage, min_voltage, vrpn_HANDLERPARAM::msg_time, NI_device_number, vrpn_Analog_Output::o_channel, vrpn_Analog_Output::o_num_channel, vrpn_BaseClassUnique::send_text_message(), vrpn_BaseClassUnique::userdata, vrpn_TEXT_ERROR, vrpn_TEXT_WARNING, and vrpn_unbuffer().

Referenced by vrpn_Analog_Output_Server_NI().

Here is the call graph for this function:

◆ mainloop()

void vrpn_Analog_Output_Server_NI::mainloop ( )
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 606 of file vrpn_NationalInstruments.C.

References vrpn_BaseClassUnique::server_mainloop().

Here is the call graph for this function:

◆ report_num_channels()

bool vrpn_Analog_Output_Server_NI::report_num_channels ( vrpn_uint32  class_of_service = vrpn_CONNECTION_RELIABLE)
protectedvirtual

◆ setNumChannels()

vrpn_int32 vrpn_Analog_Output_Server_NI::setNumChannels ( vrpn_int32  sizeRequested)
protected

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 612 of file vrpn_NationalInstruments.C.

References vrpn_Analog_Output::o_num_channel, and vrpn_CHANNEL_MAX.

Referenced by vrpn_Analog_Output_Server_NI().

Member Data Documentation

◆ max_voltage

double vrpn_Analog_Output_Server_NI::max_voltage
protected

◆ min_voltage

double vrpn_Analog_Output_Server_NI::min_voltage
protected

◆ NI_device_number

short vrpn_Analog_Output_Server_NI::NI_device_number
protected

◆ NI_num_channels

short vrpn_Analog_Output_Server_NI::NI_num_channels
protected

Definition at line 117 of file vrpn_NationalInstruments.h.

Referenced by vrpn_Analog_Output_Server_NI().

◆ polarity

short vrpn_Analog_Output_Server_NI::polarity
protected

Definition at line 120 of file vrpn_NationalInstruments.h.

Referenced by vrpn_Analog_Output_Server_NI().


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