All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
SurgSim::Input::InputConsumer Class Reference

An input consumer monitors device and signal state update. More...

Inheritance diagram for SurgSim::Input::InputConsumer:
Inheritance graph
[legend]
Collaboration diagram for SurgSim::Input::InputConsumer:
Collaboration graph
[legend]

Public Member Functions

 InputConsumer ()
 Constructor. More...
 
virtual ~InputConsumer ()
 Destructor. More...
 
virtual void handleInput (const std::string &device, const SurgSim::DataStructures::DataGroup &inputData) override
 Handle the input coming from device. More...
 
virtual void initializeInput (const std::string &device, const SurgSim::DataStructures::DataGroup &initialData) override
 Initialize the input data information stored in this input consumer. More...
 
void getData (SurgSim::DataStructures::DataGroup *dataGroup)
 Retrieve input data information stored in this input consumer. More...
 
- Public Member Functions inherited from SurgSim::Input::InputConsumerInterface
virtual ~InputConsumerInterface ()
 Virtual destructor (empty). More...
 

Private Attributes

SurgSim::Framework::LockedContainer
< SurgSim::DataStructures::DataGroup
m_lastInput
 Used to store input data information passed in from device. More...
 

Detailed Description

An input consumer monitors device and signal state update.

Constructor & Destructor Documentation

SurgSim::Input::InputConsumer::InputConsumer ( )
inline

Constructor.

virtual SurgSim::Input::InputConsumer::~InputConsumer ( )
inlinevirtual

Destructor.

Member Function Documentation

void SurgSim::Input::InputConsumer::getData ( SurgSim::DataStructures::DataGroup dataGroup)
inline

Retrieve input data information stored in this input consumer.

Parameters
[out]dataGroupUsed to accept the retrieved input data information
virtual void SurgSim::Input::InputConsumer::handleInput ( const std::string &  device,
const SurgSim::DataStructures::DataGroup inputData 
)
inlineoverridevirtual

Handle the input coming from device.

Parameters
deviceThe name of the device that is producing the input.
inputDataThe input data coming from the device.

Implements SurgSim::Input::InputConsumerInterface.

virtual void SurgSim::Input::InputConsumer::initializeInput ( const std::string &  device,
const SurgSim::DataStructures::DataGroup initialData 
)
inlineoverridevirtual

Initialize the input data information stored in this input consumer.

Parameters
deviceThe name of the device that is producing the input.
initialDataInitial input data of the device.

Implements SurgSim::Input::InputConsumerInterface.

Member Data Documentation

SurgSim::Framework::LockedContainer<SurgSim::DataStructures::DataGroup> SurgSim::Input::InputConsumer::m_lastInput
private

Used to store input data information passed in from device.


The documentation for this class was generated from the following file: