vrpn_Imager_Server类 参考

类 vrpn_Imager_Server 继承关系图:

vrpn_Imager_Server 的协作图:

Public 成员函数
	vrpn_Imager_Server (const char *name, vrpn_Connection *c, vrpn_int32 nCols, vrpn_int32 nRows, vrpn_int32 nDepth=1)
int	add_channel (const char *name, const char *units="unsigned8bit", vrpn_float32 minVal=0, vrpn_float32 maxVal=255, vrpn_float32 scale=1, vrpn_float32 offset=0)
bool	send_begin_frame (const vrpn_uint16 cMin, const vrpn_uint16 cMax, const vrpn_uint16 rMin, const vrpn_uint16 rMax, const vrpn_uint16 dMin=0, const vrpn_uint16 dMax=0, const struct timeval *time=NULL)
bool	send_end_frame (const vrpn_uint16 cMin, const vrpn_uint16 cMax, const vrpn_uint16 rMin, const vrpn_uint16 rMax, const vrpn_uint16 dMin=0, const vrpn_uint16 dMax=0, const struct timeval *time=NULL)
bool	send_discarded_frames (const vrpn_uint16 count=0, const struct timeval *time=NULL)
bool	send_region_using_base_pointer (vrpn_int16 chanIndex, vrpn_uint16 cMin, vrpn_uint16 cMax, vrpn_uint16 rMin, vrpn_uint16 rMax, const vrpn_uint8 *data, vrpn_uint32 colStride, vrpn_uint32 rowStride, vrpn_uint16 nRows=0, bool invert_rows=false, vrpn_uint32 depthStride=0, vrpn_uint16 dMin=0, vrpn_uint16 dMax=0, const struct timeval *time=NULL)
bool	send_region_using_base_pointer (vrpn_int16 chanIndex, vrpn_uint16 cMin, vrpn_uint16 cMax, vrpn_uint16 rMin, vrpn_uint16 rMax, const vrpn_uint16 *data, vrpn_uint32 colStride, vrpn_uint32 rowStride, vrpn_uint16 nRows=0, bool invert_rows=false, vrpn_uint32 depthStride=0, vrpn_uint16 dMin=0, vrpn_uint16 dMax=0, const struct timeval *time=NULL)
bool	send_region_using_base_pointer (vrpn_int16 chanIndex, vrpn_uint16 cMin, vrpn_uint16 cMax, vrpn_uint16 rMin, vrpn_uint16 rMax, const vrpn_float32 *data, vrpn_uint32 colStride, vrpn_uint32 rowStride, vrpn_uint16 nRows=0, bool invert_rows=false, vrpn_uint32 depthStride=0, vrpn_uint16 dMin=0, vrpn_uint16 dMax=0, const struct timeval *time=NULL)
bool	send_region_using_first_pointer (vrpn_int16 chanIndex, vrpn_uint16 cMin, vrpn_uint16 cMax, vrpn_uint16 rMin, vrpn_uint16 rMax, const vrpn_uint8 *data, vrpn_uint32 colStride, vrpn_uint32 rowStride, vrpn_uint16 nRows=0, bool invert_rows=false, vrpn_uint32 depthStride=0, vrpn_uint16 dMin=0, vrpn_uint16 dMax=0, const struct timeval *time=NULL)
bool	send_region_using_first_pointer (vrpn_int16 chanIndex, vrpn_uint16 cMin, vrpn_uint16 cMax, vrpn_uint16 rMin, vrpn_uint16 rMax, const vrpn_uint16 *data, vrpn_uint32 colStride, vrpn_uint32 rowStride, vrpn_uint16 nRows=0, bool invert_rows=false, vrpn_uint32 depthStride=0, vrpn_uint16 dMin=0, vrpn_uint16 dMax=0, const struct timeval *time=NULL)
bool	send_region_using_first_pointer (vrpn_int16 chanIndex, vrpn_uint16 cMin, vrpn_uint16 cMax, vrpn_uint16 rMin, vrpn_uint16 rMax, const vrpn_float32 *data, vrpn_uint32 colStride, vrpn_uint32 rowStride, vrpn_uint16 nRows=0, bool invert_rows=false, vrpn_uint32 depthStride=0, vrpn_uint16 dMin=0, vrpn_uint16 dMax=0, const struct timeval *time=NULL)
bool	set_resolution (vrpn_int32 nCols, vrpn_int32 nRows, vrpn_int32 nDepth=1)
bool	send_description (void)
virtual void	mainloop (void)
	Handle baseclass ping/pong messages
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_ping_message (void *userdata, vrpn_HANDLERPARAM p)
static int VRPN_CALLBACK	handle_throttle_message (void *userdata, vrpn_HANDLERPARAM p)
static int VRPN_CALLBACK	handle_last_drop_message (void *userdata, vrpn_HANDLERPARAM p)
静态 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_description_sent
vrpn_int32	d_frames_to_send
vrpn_uint16	d_dropped_due_to_throttle
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)

成员函数说明

add_channel()

int add_channel	(	const char *	name,
		const char *	units = "unsigned8bit",
		vrpn_float32	minVal = 0,
		vrpn_float32	maxVal = 255,
		vrpn_float32	scale = 1,
		vrpn_float32	offset = 0 )

Add a channel to the server, returns index of the channel or -1 on failure.

mainloop()

virtual void mainloop ( void )

virtual

Handle baseclass ping/pong messages

实现了 vrpn_BaseClass.

被 vrpn_Imager_Stream_Buffer 重载.

send_begin_frame()

bool send_begin_frame	(	const vrpn_uint16	cMin,
		const vrpn_uint16	cMax,
		const vrpn_uint16	rMin,
		const vrpn_uint16	rMax,
		const vrpn_uint16	dMin = 0,
		const vrpn_uint16	dMax = 0,
		const struct timeval *	time = NULL )

Servers must send begin/end frame pairs around contiguous sections of the image

send_description()

bool send_description

(

void

)

Sends a description of the imager so the remote can process the region messages

send_region_using_base_pointer()

bool send_region_using_base_pointer	(	vrpn_int16	chanIndex,
		vrpn_uint16	cMin,
		vrpn_uint16	cMax,
		vrpn_uint16	rMin,
		vrpn_uint16	rMax,
		const vrpn_uint8 *	data,
		vrpn_uint32	colStride,
		vrpn_uint32	rowStride,
		vrpn_uint16	nRows = 0,
		bool	invert_rows = false,
		vrpn_uint32	depthStride = 0,
		vrpn_uint16	dMin = 0,
		vrpn_uint16	dMax = 0,
		const struct timeval *	time = NULL )

Pack and send the region as efficiently as possible; strides are in steps of the element being sent.

send_region_using_first_pointer()

bool send_region_using_first_pointer	(	vrpn_int16	chanIndex,
		vrpn_uint16	cMin,
		vrpn_uint16	cMax,
		vrpn_uint16	rMin,
		vrpn_uint16	rMax,
		const vrpn_uint8 *	data,
		vrpn_uint32	colStride,
		vrpn_uint32	rowStride,
		vrpn_uint16	nRows = 0,
		bool	invert_rows = false,
		vrpn_uint32	depthStride = 0,
		vrpn_uint16	dMin = 0,
		vrpn_uint16	dMax = 0,
		const struct timeval *	time = NULL )

Pack and send the region as efficiently as possible; strides are in steps of the element being sent.

set_resolution()

bool set_resolution	(	vrpn_int32	nCols,
		vrpn_int32	nRows,
		vrpn_int32	nDepth = 1 )

Set the resolution to a different value than it had been before. Returns true on success.

---

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

• simulink/vrpn/vrpn_Imager.h