Public Member Functions | Public Attributes | List of all members
TestListener Struct Reference
Inheritance diagram for TestListener:
SurgSim::Input::InputConsumerInterface SurgSim::Input::InputConsumerInterface

Public Member Functions

 TestListener ()
 
virtual void initializeInput (const std::string &device, const DataGroup &inputData) override
 Set the initial input data group. More...
 
virtual void handleInput (const std::string &device, const DataGroup &inputData) override
 Notifies the consumer that the application input coming from the device has been updated. More...
 
void creatKeyMap ()
 
void createModifierMap ()
 
virtual void initializeInput (const std::string &device, const DataGroup &inputData) override
 Set the initial input data group. More...
 
virtual void handleInput (const std::string &device, const DataGroup &inputData) override
 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). More...
 

Public Attributes

std::map< int, std::stringkeyMap
 
std::map< int, std::stringmodifierMap
 

Constructor & Destructor Documentation

TestListener::TestListener ( )
inline

Member Function Documentation

void TestListener::createModifierMap ( )
inline
void TestListener::creatKeyMap ( )
inline
virtual void TestListener::handleInput ( const std::string device,
const DataGroup inputData 
)
inlineoverridevirtual

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
deviceThe 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).
inputDataThe application input state coming from the device.

Implements SurgSim::Input::InputConsumerInterface.

virtual void TestListener::handleInput ( const std::string device,
const DataGroup inputData 
)
inlineoverridevirtual

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
deviceThe 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).
inputDataThe application input state coming from the device.

Implements SurgSim::Input::InputConsumerInterface.

virtual void TestListener::initializeInput ( const std::string device,
const DataGroup inputData 
)
inlineoverridevirtual

Set the initial input data group.

Parameters
deviceThe 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).
inputDataThe application input state coming from the device.

Implements SurgSim::Input::InputConsumerInterface.

virtual void TestListener::initializeInput ( const std::string device,
const DataGroup inputData 
)
inlineoverridevirtual

Set the initial input data group.

Parameters
deviceThe 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).
inputDataThe application input state coming from the device.

Implements SurgSim::Input::InputConsumerInterface.

Member Data Documentation

std::map<int, std::string> TestListener::keyMap
std::map<int, std::string> TestListener::modifierMap

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