Inheritance diagram for TestInputConsumer:

Public Member Functions
virtual void	initializeInput (const std::string &device, const DataGroup &initialInput)
	Set the initial input data group. More...

virtual void	handleInput (const std::string &device, const DataGroup &inputData)
	Notifies the consumer that the application input coming from the device has been updated. More...

Public Member Functions inherited from SurgSim::Input::InputConsumerInterface
virtual	~InputConsumerInterface ()
	Virtual destructor (empty).

Member Function Documentation

§ handleInput()

void TestInputConsumer::handleInput	(	const std::string &	device,
		const DataGroup &	inputData
	)

virtual

Notifies the consumer that the application input coming from the device has been updated.

Typical input data contents (but note that individual devices may do things differently):

type	name
pose	"pose"	Device pose (units are meters).
bool	"button1"	State of the first device button.
bool	"button2"	State of the second device button (and so on).

Other possible contents includes:

type	name
bool	"isHomed"	Device homing status.
bool	"isHomedX"	Individual homing status for the X axis (and so on).
bool	"isHeld"	Safety sensor etc. status.
string	"model"	Device model description.
string	"serial"	Serial number string.
(any)	"debug:*"	Various debugging information

Parameters

device	The name of the device that is producing the input. This should only be used to identify the device (e.g. if the consumer is listening to several devices at once).
inputData	The application input state coming from the device.

virtual void TestInputConsumer::initializeInput	(	const std::string &	device,
		const DataGroup &	inputData
	)

inlinevirtual

Set the initial input data group.

Parameters

device	The name of the device that is producing the input. This should only be used to identify the device (e.g. if the consumer is listening to several devices at once).
inputData	The application input state coming from the device.

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