InputManager.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_INPUTMANAGER_H
17 #define SURGSIM_INPUT_INPUTMANAGER_H
18 
19 #include <boost/thread/mutex.hpp>
20 #include <memory>
21 #include <unordered_map>
22 #include <vector>
23 
25 
26 namespace SurgSim
27 {
28 namespace Input
29 {
30 class DeviceInterface;
31 class InputComponent;
32 class OutputComponent;
33 
38 {
39 public:
40  InputManager();
41  virtual ~InputManager();
42 
43  friend class InputManagerTest;
44 
48  bool addDevice(std::shared_ptr<SurgSim::Input::DeviceInterface> device);
49 
53  bool removeDevice(std::shared_ptr<SurgSim::Input::DeviceInterface> device);
54 
55  int getType() const override;
56 
57 private:
58  bool doInitialize() override;
59  bool doStartUp() override;
60  bool doUpdate(double dt) override;
61  void doBeforeStop() override;
62 
71  bool executeAdditions(const std::shared_ptr<SurgSim::Framework::Component>& component) override;
72 
76  bool executeRemovals(const std::shared_ptr<SurgSim::Framework::Component>& component) override;
77 
78 
82  bool addInputComponent(const std::shared_ptr<InputComponent>& input);
84  bool addOutputComponent(const std::shared_ptr<OutputComponent>& output);
85 
90  bool tryFindDevice(const std::string& name, DeviceInterface** device);
91 
93  std::vector<std::shared_ptr<InputComponent>> m_inputs;
95  std::vector<std::shared_ptr<OutputComponent>> m_outputs;
96 
100  std::unordered_map<std::string, std::shared_ptr<SurgSim::Input::DeviceInterface>> m_devices;
101 
103  boost::mutex m_mutex;
104 };
105 
106 }; //namespace Input
107 }; //namespace SurgSim
108 #endif
SurgSim::Input::InputManager::doInitialize
bool doInitialize() override
Definition: InputManager.cpp:37
SurgSim::Input::InputManager::~InputManager
virtual ~InputManager()
Definition: InputManager.cpp:33
SurgSim::Input::InputManager::addOutputComponent
bool addOutputComponent(const std::shared_ptr< OutputComponent > &output)
Specific call for output components.
Definition: InputManager.cpp:131
SurgSim::Input::InputManager::addDevice
bool addDevice(std::shared_ptr< SurgSim::Input::DeviceInterface > device)
Adds a device to the manager.
Definition: InputManager.cpp:161
SurgSim::Input::InputManager::doBeforeStop
void doBeforeStop() override
Prepares the thread for its execution to be stopped.
Definition: InputManager.cpp:54
SurgSim::Input::InputManager::m_devices
std::unordered_map< std::string, std::shared_ptr< SurgSim::Input::DeviceInterface > > m_devices
Collection of all devices that have been added to the input manager key is the name,...
Definition: InputManager.h:100
ComponentManager.h
SurgSim::Input::InputManager::tryFindDevice
bool tryFindDevice(const std::string &name, DeviceInterface **device)
Returns a device with the given name, if one is available.
Definition: InputManager.cpp:207
SurgSim::Input::InputManager
Manager to handle InputComponent and OutputComponent, SceneElement can add these to get input from de...
Definition: InputManager.h:37
SurgSim::Input::InputManager::removeDevice
bool removeDevice(std::shared_ptr< SurgSim::Input::DeviceInterface > device)
Removes the device described by device.
Definition: InputManager.cpp:184
SurgSim::Input::InputManager::m_mutex
boost::mutex m_mutex
Protect critical sections.
Definition: InputManager.h:103
SurgSim::Framework::ComponentManager
Base Component Manager class.
Definition: ComponentManager.h:49
SurgSim
Definition: CompoundShapeToGraphics.cpp:29
SurgSim::Input::InputManager::doUpdate
bool doUpdate(double dt) override
Implementation of actual work function for this thread, this has a default implementation to handle d...
Definition: InputManager.cpp:47
SurgSim::Input::InputManager::executeAdditions
bool executeAdditions(const std::shared_ptr< SurgSim::Framework::Component > &component) override
Adds a component, this can be either input or output, it will call the appropriate function in the de...
Definition: InputManager.cpp:62
SurgSim::Input::DeviceInterface
Interface used to communicate with user-interface hardware devices.
Definition: DeviceInterface.h:41
SurgSim::Input::InputManager::InputManagerTest
friend class InputManagerTest
Definition: InputManager.h:43
SurgSim::Input::InputManager::doStartUp
bool doStartUp() override
Definition: InputManager.cpp:42
SurgSim::Input::InputManager::m_inputs
std::vector< std::shared_ptr< InputComponent > > m_inputs
Collection of all input components.
Definition: InputManager.h:93
SurgSim::Input::InputManager::InputManager
InputManager()
Definition: InputManager.cpp:28
SurgSim::Input::InputManager::getType
int getType() const override
Returns the type of Manager.
Definition: InputManager.cpp:202
SurgSim::Input::InputManager::m_outputs
std::vector< std::shared_ptr< OutputComponent > > m_outputs
Collection of all output components.
Definition: InputManager.h:95
SurgSim::Input::InputManager::addInputComponent
bool addInputComponent(const std::shared_ptr< InputComponent > &input)
Specific call for input components.
Definition: InputManager.cpp:112
string
string(TOUPPER ${DEVICE} DEVICE_UPPER_CASE) option(BUILD_DEVICE_$
Definition: CMakeLists.txt:38
SurgSim::Input::InputManager::executeRemovals
bool executeRemovals(const std::shared_ptr< SurgSim::Framework::Component > &component) override
Removes the component described by component.
Definition: InputManager.cpp:85