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

Base class for Imager class. More...

#include <vrpn_Imager.h>

Inheritance diagram for vrpn_Imager:
Collaboration diagram for vrpn_Imager:

Public Member Functions

 vrpn_Imager (const char *name, vrpn_Connection *c=NULL)
 
vrpn_int32 nRows (void) const
 
vrpn_int32 nCols (void) const
 
vrpn_int32 nDepth (void) const
 
vrpn_int32 nChannels (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 ()
 
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_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using.
 

Protected Member Functions

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.
 
virtual int register_types (void)=0
 Register the types of messages this device sends/receives. 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_int32 d_nRows
 
vrpn_int32 d_nCols
 
vrpn_int32 d_nDepth
 
vrpn_int32 d_nChannels
 
vrpn_Imager_Channel d_channels [vrpn_IMAGER_MAX_CHANNELS]
 
vrpn_int32 d_description_m_id
 
vrpn_int32 d_begin_frame_m_id
 
vrpn_int32 d_end_frame_m_id
 
vrpn_int32 d_discarded_frames_m_id
 
vrpn_int32 d_throttle_frames_m_id
 
vrpn_int32 d_regionu8_m_id
 
vrpn_int32 d_regionu12in16_m_id
 
vrpn_int32 d_regionu16_m_id
 
vrpn_int32 d_regionf32_m_id
 
- 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
 
- 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

Base class for Imager class.

Definition at line 120 of file vrpn_Imager.h.

Constructor & Destructor Documentation

◆ vrpn_Imager()

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

Definition at line 6 of file vrpn_Imager.C.

References vrpn_BaseClass::init().

Here is the call graph for this function:

Member Function Documentation

◆ nChannels()

vrpn_int32 vrpn_Imager::nChannels ( void  ) const
inline

Definition at line 128 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Stream_Buffer::handle_image_description().

◆ nCols()

◆ nDepth()

◆ nRows()

◆ register_types()

int vrpn_Imager::register_types ( void  )
protectedvirtual

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

Implements vrpn_BaseClass.

Definition at line 16 of file vrpn_Imager.C.

References d_begin_frame_m_id, vrpn_BaseClassUnique::d_connection, d_description_m_id, d_discarded_frames_m_id, d_end_frame_m_id, d_regionf32_m_id, d_regionu12in16_m_id, d_regionu16_m_id, d_regionu8_m_id, d_throttle_frames_m_id, and vrpn_Connection::register_message_type().

Here is the call graph for this function:

Member Data Documentation

◆ d_begin_frame_m_id

◆ d_channels

◆ d_description_m_id

vrpn_int32 vrpn_Imager::d_description_m_id
protected

◆ d_discarded_frames_m_id

vrpn_int32 vrpn_Imager::d_discarded_frames_m_id
protected

◆ d_end_frame_m_id

vrpn_int32 vrpn_Imager::d_end_frame_m_id
protected

◆ d_nChannels

◆ d_nCols

◆ d_nDepth

◆ d_nRows

◆ d_regionf32_m_id

◆ d_regionu12in16_m_id

vrpn_int32 vrpn_Imager::d_regionu12in16_m_id
protected

Definition at line 150 of file vrpn_Imager.h.

Referenced by register_types(), and vrpn_Imager_Stream_Buffer::transcode_type().

◆ d_regionu16_m_id

◆ d_regionu8_m_id

◆ d_throttle_frames_m_id

vrpn_int32 vrpn_Imager::d_throttle_frames_m_id
protected

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