InputConsumerInterface.h
Go to the documentation of this file.
1 // This file is a part of the OpenSurgSim project.
2 // Copyright 2013, SimQuest Solutions Inc.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 // http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 
16 #ifndef SURGSIM_INPUT_INPUTCONSUMERINTERFACE_H
17 #define SURGSIM_INPUT_INPUTCONSUMERINTERFACE_H
18 
19 #include <string>
20 
21 namespace SurgSim
22 {
23 namespace DataStructures
24 {
25 class DataGroup;
26 }; // namespace DataStructures
27 
28 namespace Input
29 {
30 
31 
34 {
35 public:
38  {
39  }
40 
63  virtual void handleInput(const std::string& device, const SurgSim::DataStructures::DataGroup& inputData) = 0;
64 
69  virtual void initializeInput(const std::string& device, const SurgSim::DataStructures::DataGroup& inputData) = 0;
70 };
71 
72 
73 }; // namespace Input
74 }; // namespace SurgSim
75 
76 #endif // SURGSIM_INPUT_INPUTCONSUMERINTERFACE_H
SurgSim::Input::InputConsumerInterface::handleInput
virtual void handleInput(const std::string &device, const SurgSim::DataStructures::DataGroup &inputData)=0
Notifies the consumer that the application input coming from the device has been updated.
SurgSim::Input::InputConsumerInterface::~InputConsumerInterface
virtual ~InputConsumerInterface()
Virtual destructor (empty).
Definition: InputConsumerInterface.h:37
SurgSim
Definition: CompoundShapeToGraphics.cpp:30
SurgSim::DataStructures::DataGroup
A collection of NamedData objects.
Definition: DataGroup.h:69
SurgSim::Input::InputConsumerInterface
Interface for a consumer that monitors device and signal state updates (pose, buttons,...
Definition: InputConsumerInterface.h:34
SurgSim::Input::InputConsumerInterface::initializeInput
virtual void initializeInput(const std::string &device, const SurgSim::DataStructures::DataGroup &inputData)=0
Set the initial input data group.
string
string(TOUPPER ${DEVICE} DEVICE_UPPER_CASE) option(BUILD_DEVICE_$
Definition: CMakeLists.txt:38