vrpn_Imager_Remote类 参考

#include <vrpn_Imager.h>

类 vrpn_Imager_Remote 继承关系图:

vrpn_Imager_Remote 的协作图:

Public 成员函数
	vrpn_Imager_Remote (const char *name, vrpn_Connection *c=NULL)
virtual int	register_region_handler (void *userdata, vrpn_IMAGERREGIONHANDLER handler)
virtual int	unregister_region_handler (void *userdata, vrpn_IMAGERREGIONHANDLER handler)
virtual int	register_description_handler (void *userdata, vrpn_IMAGERDESCRIPTIONHANDLER handler)
virtual int	unregister_description_handler (void *userdata, vrpn_IMAGERDESCRIPTIONHANDLER handler)
virtual int	register_begin_frame_handler (void *userdata, vrpn_IMAGERBEGINFRAMEHANDLER handler)
	Register a handler for frame beginning (if the application cares)
virtual int	unregister_begin_frame_handler (void *userdata, vrpn_IMAGERBEGINFRAMEHANDLER handler)
virtual int	register_end_frame_handler (void *userdata, vrpn_IMAGERENDFRAMEHANDLER handler)
	Register a handler for frame end (if the application cares)
virtual int	unregister_end_frame_handler (void *userdata, vrpn_IMAGERENDFRAMEHANDLER handler)
virtual int	register_discarded_frames_handler (void *userdata, vrpn_IMAGERDISCARDEDFRAMESHANDLER handler)
virtual int	unregister_discarded_frames_handler (void *userdata, vrpn_IMAGERDISCARDEDFRAMESHANDLER handler)
virtual bool	throttle_sender (vrpn_int32 N)
virtual void	mainloop (void)
	XXX It could be nice to let the user specify separate callbacks for
const vrpn_Imager_Channel *	channel (unsigned chanNum) const
bool	is_description_valid ()
	have we gotten a description message yet?
Public 成员函数 继承自 vrpn_Imager
	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 成员函数 继承自 vrpn_BaseClass
	vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL)
Public 成员函数 继承自 vrpn_BaseClassUnique
vrpn_Connection *	connectionPtr ()
	Returns a pointer to the connection this object is using

静态 Protected 成员函数
static int VRPN_CALLBACK	handle_region_message (void *userdata, vrpn_HANDLERPARAM p)
	Handler for region update message from the server.
static int VRPN_CALLBACK	handle_description_message (void *userdata, vrpn_HANDLERPARAM p)
	Handler for resolution and channel list message from the server.
static int VRPN_CALLBACK	handle_connection_dropped_message (void *userdata, vrpn_HANDLERPARAM p)
	Handler for connection dropped message
static int VRPN_CALLBACK	handle_begin_frame_message (void *userdata, vrpn_HANDLERPARAM p)
	Handler for begin-frame message from the server.
static int VRPN_CALLBACK	handle_end_frame_message (void *userdata, vrpn_HANDLERPARAM p)
	Handler for end-frame message from the server.
static int VRPN_CALLBACK	handle_discarded_frames_message (void *userdata, vrpn_HANDLERPARAM p)
	Handler for discarded-frames message from the server.
静态 Protected 成员函数 继承自 vrpn_BaseClassUnique
static int	encode_text_message_to_buffer (char *buf, vrpn_TEXT_SEVERITY severity, vrpn_uint32 level, const char *msg)
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 属性
bool	d_got_description
vrpn_Callback_List< struct timeval >	d_description_list
vrpn_Callback_List< vrpn_IMAGERREGIONCB >	d_region_list
vrpn_Callback_List< vrpn_IMAGERBEGINFRAMECB >	d_begin_frame_list
vrpn_Callback_List< vrpn_IMAGERENDFRAMECB >	d_end_frame_list
vrpn_Callback_List< vrpn_IMAGERDISCARDEDFRAMESCB >	d_discarded_frames_list
Protected 属性 继承自 vrpn_Imager
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 属性 继承自 vrpn_BaseClassUnique
vrpn_Connection *	d_connection
	Connection that this object talks to
char *	d_servicename
vrpn_int32	d_sender_id
	part
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

额外继承的成员函数
Public 属性 继承自 vrpn_BaseClassUnique
bool	shutup
Protected 成员函数 继承自 vrpn_Imager
virtual int	register_types (void)
Protected 成员函数 继承自 vrpn_BaseClass
virtual int	init (void)
virtual int	register_senders (void)
Protected 成员函数 继承自 vrpn_BaseClassUnique
int	register_autodeleted_handler (vrpn_int32 type, vrpn_MESSAGEHANDLER handler, void *userdata, vrpn_int32 sender=vrpn_ANY_SENDER)
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)
void	server_mainloop (void)
void	client_mainloop (void)

详细描述

This is the class users deal with: it tells the format and the region data when it arrives.

成员函数说明

channel()

const vrpn_Imager_Channel * channel

(

unsigned

chanNum

)

const

Accessors for the member variables: can be queried in the handler for object changes

handle_begin_frame_message()

static int VRPN_CALLBACK handle_begin_frame_message ( void * userdata, vrpn_HANDLERPARAM p )

staticprotected

Handler for begin-frame message from the server.

handle_connection_dropped_message()

static int VRPN_CALLBACK handle_connection_dropped_message ( void * userdata, vrpn_HANDLERPARAM p )

staticprotected

Handler for connection dropped message

handle_description_message()

static int VRPN_CALLBACK handle_description_message ( void * userdata, vrpn_HANDLERPARAM p )

staticprotected

Handler for resolution and channel list message from the server.

handle_discarded_frames_message()

static int VRPN_CALLBACK handle_discarded_frames_message ( void * userdata, vrpn_HANDLERPARAM p )

staticprotected

Handler for discarded-frames message from the server.

handle_end_frame_message()

static int VRPN_CALLBACK handle_end_frame_message ( void * userdata, vrpn_HANDLERPARAM p )

staticprotected

Handler for end-frame message from the server.

handle_region_message()

static int VRPN_CALLBACK handle_region_message ( void * userdata, vrpn_HANDLERPARAM p )

staticprotected

Handler for region update message from the server.

is_description_valid()

bool is_description_valid ( )

inline

have we gotten a description message yet?

mainloop()

virtual void mainloop ( void )

virtual

XXX It could be nice to let the user specify separate callbacks for

Call this each time through the program's main loop

实现了 vrpn_BaseClass.

register_begin_frame_handler()

virtual int register_begin_frame_handler ( void * userdata, vrpn_IMAGERBEGINFRAMEHANDLER handler )

inlinevirtual

Register a handler for frame beginning (if the application cares)

register_description_handler()

virtual int register_description_handler ( void * userdata, vrpn_IMAGERDESCRIPTIONHANDLER handler )

inlinevirtual

Register a handler for when the object's description changes (if desired).

register_discarded_frames_handler()

virtual int register_discarded_frames_handler ( void * userdata, vrpn_IMAGERDISCARDEDFRAMESHANDLER handler )

inlinevirtual

Register a handler for discarded frame notifications (if the application cares)

register_end_frame_handler()

virtual int register_end_frame_handler ( void * userdata, vrpn_IMAGERENDFRAMEHANDLER handler )

inlinevirtual

Register a handler for frame end (if the application cares)

register_region_handler()

virtual int register_region_handler ( void * userdata, vrpn_IMAGERREGIONHANDLER handler )

inlinevirtual

Register a handler for when new data arrives (can look up info in object when this happens)

throttle_sender()

virtual bool throttle_sender ( vrpn_int32 N )

virtual

Request that the server send at most N more frames until a new request is sent.

---

该类的文档由以下文件生成:

• simulink/vrpn/vrpn_Imager.h