vrpn_BaseClass类 参考

#include <vrpn_BaseClass.h>

类 vrpn_BaseClass 继承关系图:

vrpn_BaseClass 的协作图:

Public 成员函数
	vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL)
virtual void	mainloop ()=0
Public 成员函数 继承自 vrpn_BaseClassUnique
vrpn_Connection *	connectionPtr ()
	Returns a pointer to the connection this object is using

Protected 成员函数
virtual int	init (void)
virtual int	register_senders (void)
virtual int	register_types (void)=0
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)

额外继承的成员函数
Public 属性 继承自 vrpn_BaseClassUnique
bool	shutup
静态 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 属性 继承自 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

详细描述

Class from which all user-level (and other) classes that communicate with vrpn_Connections should derive.

构造及析构函数说明

vrpn_BaseClass()

vrpn_BaseClass	(	const char *	name,
		vrpn_Connection *	c = NULL )

Names the device and assigns or opens connection, calls registration methods

成员函数说明

init()

virtual int init ( void )

protectedvirtual

Initialize things that the constructor can't. Returns 0 on success, -1 on failure.

mainloop()

virtual void mainloop ( )

pure 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().

在 vrpn_3DConnexion, vrpn_3DMicroscribe, vrpn_5dt16, vrpn_5dt, vrpn_ADBox, vrpn_Analog_5dtUSB, vrpn_Analog_Output_Remote, vrpn_Analog_Output_Server, vrpn_Analog_Output_Server_NI, vrpn_Analog_Remote, vrpn_Analog_Server, vrpn_Analog_USDigital_A2, vrpn_Atmel, vrpn_Auxiliary_Logger_Remote, vrpn_Auxiliary_Logger_Server, vrpn_Auxiliary_Logger_Server_Generic, vrpn_BiosciencesTools, vrpn_Button_5DT_Server, vrpn_Button_Example_Server, vrpn_Button_NI_DIO24, vrpn_Button_PinchGlove, vrpn_Button_Python, vrpn_Button_Remote, vrpn_Button_SerialMouse, vrpn_Button_Server, vrpn_CerealBox, vrpn_CHProducts_Controller_Raw, vrpn_CHProducts_Fighterstick_USB, vrpn_Contour, vrpn_Contour_ShuttlePROv2, vrpn_Contour_ShuttleXpress, vrpn_Dial_Example_Server, vrpn_Dial_Remote, vrpn_DreamCheeky, vrpn_DreamCheeky_Drum_Kit, vrpn_Event_Mouse, vrpn_ForceDevice_Remote, vrpn_FunctionGenerator_Remote, vrpn_FunctionGenerator_Server, vrpn_Futaba, vrpn_Futaba_InterLink_Elite, vrpn_GlobalHapticsOrb, vrpn_Griffin, vrpn_Griffin_PowerMate, vrpn_IDEA, vrpn_Imager_Remote, vrpn_Imager_Server, vrpn_Imager_Stream_Buffer, vrpn_ImagerPose_Remote, vrpn_ImagerPose_Server, vrpn_ImmersionBox, vrpn_IMU_Magnetometer, vrpn_IMU_SimpleCombiner, vrpn_inertiamouse, vrpn_Joylin, vrpn_Joystick, vrpn_Keyboard, vrpn_Laputa, vrpn_Logitech_Controller_Raw, vrpn_Logitech_Extreme_3D_Pro, vrpn_Magellan, vrpn_Microsoft_Controller_Raw, vrpn_Microsoft_Controller_Raw_Xbox_360_base, vrpn_Microsoft_Controller_Raw_Xbox_S, vrpn_Microsoft_SideWinder, vrpn_Microsoft_SideWinder_Precision_2, vrpn_Mouse, vrpn_National_Instruments_Server, vrpn_Nikon_Controls, vrpn_nVidia_shield, vrpn_nVidia_shield_stealth_USB, vrpn_nVidia_shield_USB, vrpn_Oculus, vrpn_Poser_Analog, vrpn_Poser_Remote, vrpn_Poser_Server, vrpn_Poser_Tek4662, vrpn_Radamec_SPI, vrpn_raw_SGIBox, vrpn_RedundantController, vrpn_RedundantRemote, vrpn_Retrolink, vrpn_Retrolink_GameCube, vrpn_Retrolink_Genesis, vrpn_Saitek_Controller_Raw, vrpn_Saitek_ST290_Pro, vrpn_Sound_Client, vrpn_Spaceball, vrpn_Streaming_Arduino, vrpn_Text_Receiver, vrpn_Text_Sender, vrpn_Tng3, vrpn_Tracker_3DMouse, vrpn_Tracker_AnalogFly, vrpn_Tracker_ButtonFly, vrpn_Tracker_Crossbow, vrpn_Tracker_DeadReckoning_Rotation, vrpn_Tracker_DTrack, vrpn_Tracker_FilterOneEuro, vrpn_Tracker_Flock_Parallel, vrpn_Tracker_Flock_Parallel_Slave, vrpn_Tracker_GameTrak, vrpn_Tracker_JoyFly, vrpn_Tracker_NDI_Polaris, vrpn_Tracker_NULL, vrpn_Tracker_OSVRHackerDevKit, vrpn_Tracker_RazerHydra, vrpn_Tracker_Remote, vrpn_Tracker_Serial, vrpn_Tracker_Server, vrpn_Tracker_SpacePoint, vrpn_Tracker_Spin, vrpn_Tracker_WiimoteHead, vrpn_Tracker_Wintracker, vrpn_Vality, vrpn_Vality_vGlass, vrpn_VPJoystick, vrpn_Wanda, vrpn_Xkeys, vrpn_Xkeys_Desktop, vrpn_Xkeys_Jog_And_Shuttle12, vrpn_Xkeys_Jog_And_Shuttle68, vrpn_Xkeys_Jog_And_Shuttle, vrpn_Xkeys_Joystick12, vrpn_Xkeys_Joystick, vrpn_Xkeys_Pro, vrpn_Xkeys_XK3, vrpn_YEI_3Space , 以及 vrpn_Zaber 内被实现.

register_senders()

virtual int register_senders ( void )

protectedvirtual

Register the sender for this device (by default, the name of the device). Return 0 on success, -1 on fail.

register_types()

virtual int register_types ( void )

protectedpure virtual

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

在 vrpn_Analog, vrpn_Analog_Output, vrpn_Auxiliary_Logger, vrpn_Button, vrpn_CHProducts_Controller_Raw, vrpn_Contour, vrpn_Dial, vrpn_DreamCheeky, vrpn_ForceDevice, vrpn_FunctionGenerator, vrpn_Futaba, vrpn_Griffin, vrpn_Imager, vrpn_ImagerPose, vrpn_Logitech_Controller_Raw, vrpn_Microsoft_Controller_Raw, vrpn_nVidia_shield, vrpn_Poser, vrpn_RedundantController, vrpn_RedundantRemote, vrpn_Retrolink, vrpn_Saitek_Controller_Raw, vrpn_Sound, vrpn_Text_Receiver, vrpn_Text_Sender, vrpn_Tracker, vrpn_Vality , 以及 vrpn_Xkeys 内被实现.

---

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

• simulink/vrpn/vrpn_BaseClass.h