Manager to handle InputComponent and OutputComponent, SceneElement can add these to get input from devices, or even write output to devices. More...
#include <InputManager.h>
Inheritance diagram for SurgSim::Input::InputManager:
Public Member Functions | |
| bool | addDevice (std::shared_ptr< SurgSim::Input::DeviceInterface > device) |
| Adds a device to the manager. More... | |
| bool | removeDevice (std::shared_ptr< SurgSim::Input::DeviceInterface > device) |
| Removes the device described by device. More... | |
| int | getType () const override |
| Returns the type of Manager. | |
 Public Member Functions inherited from SurgSim::Framework::ComponentManager | |
| ComponentManager (const std::string &name="Unknown Component Manager") | |
| bool | enqueueAddComponent (const std::shared_ptr< Component > &component) |
| Queues a component to be added later. More... | |
| bool | enqueueRemoveComponent (const std::shared_ptr< Component > &component) |
| Queues a component to be removed. More... | |
| std::shared_ptr< Runtime > | getRuntime () const |
| void | setRuntime (std::shared_ptr< Runtime > val) |
| Public Member Functions inherited from SurgSim::Framework::BasicThread | |
| BasicThread (const std::string &name="Unknown Thread") | |
| virtual | ~BasicThread () noexcept(false) |
| C++11 introduced noexcept. | |
| void | start (std::shared_ptr< Barrier > startupBarrier=nullptr, bool isSynchronous=false) |
| Live cycle functions, public implementation. More... | |
| void | stop () |
| Stopping the execution, blocks until the running thread has actually stopped,. More... | |
| void | setIdle (bool isIdle) |
| Set/Unset the thread in an idle state (doUpdate() called or not in the update() method) More... | |
| bool | isIdle () |
| Query if this thread is in idle state or not. More... | |
| bool | isInitialized () |
| Query if this object is initialized. More... | |
| bool | isRunning () const |
| Query if this object is running. More... | |
| void | operator() () |
| This is what boost::thread executes on thread creation. | |
| boost::thread & | getThread () |
| std::string | getName () const |
| void | setRate (double val) |
| Set the update rate of the thread. More... | |
| bool | setSynchronous (bool val) |
| Sets the thread to synchronized execution in concert with the startup barrier, the startup barrier has to exist for this call to succeed. More... | |
| bool | isSynchronous () |
| Query if this object is synchronized. More... | |
| double | getCpuTime () const |
| size_t | getUpdateCount () const |
| void | resetCpuTimeAndUpdateCount () |
| Reset the cpu time and the update count to 0. | |
| bool | ignoresExceptions () const |
| void | setIgnoreExceptions (bool val) |
Friends | |
| class | InputManagerTest |
Additional Inherited Members | |
| Protected Member Functions inherited from SurgSim::Framework::ComponentManager | |
| template<class T > | |
| std::shared_ptr< T > | tryAddComponent (std::shared_ptr< SurgSim::Framework::Component > component, std::vector< std::shared_ptr< T >> *container) |
| Template version of the addComponent method. More... | |
| template<class T > | |
| bool | tryRemoveComponent (std::shared_ptr< SurgSim::Framework::Component > component, std::vector< std::shared_ptr< T >> *container) |
| Template version of the removeComponent method. More... | |
| void | processComponents () |
| Processes all the components that are scheduled for addition or removal, this needs to be called inside the doUpdate() function. More... | |
| void | processBehaviors (const double dt) |
| Processes behaviors This needs to be called inside doUpdate() function in each 'sub' manager. More... | |
| void | copyScheduledComponents (std::vector< std::shared_ptr< Component >> *inflightAdditions, std::vector< std::shared_ptr< Component >> *inflightRemovals, std::vector< std::shared_ptr< SceneElement >> *inflightElements) |
| Helper, blocks access to the additions and removal queue and copies the components from there to the intermediate inflight queues, after this call, the incoming queues will be empty. More... | |
| std::shared_ptr< SurgSim::Framework::Logger > | getLogger () const |
| Returns this manager's logger. | |
| template<class T > | |
| void | retireComponents (const std::vector< std::shared_ptr< T >> &container) |
| Protected Member Functions inherited from SurgSim::Framework::BasicThread | |
| bool | initialize () |
| Trigger the initialization of this object, this will be called before all other threads doStartup() are called. More... | |
| bool | startUp () |
| Trigger the startup of this object, this will be called after all other threads doInit() was called the thread will only enter the run loop triggering upated() if all threads doInit() and doStartup() returned true. More... | |
| bool | waitForBarrier (bool success) |
| Protected Attributes inherited from SurgSim::Framework::ComponentManager | |
| boost::mutex | m_componentMutex |
| Blocks protects addition and removal queues. | |
| std::vector< std::shared_ptr< SurgSim::Framework::Behavior > > | m_behaviors |
| Collection of behaviors. | |
| std::vector< std::shared_ptr< Component > > | m_componentAdditions |
| std::vector< std::shared_ptr< Component > > | m_componentRemovals |
| std::vector< std::shared_ptr< SceneElement > > | m_elementCache |
| Protected Attributes inherited from SurgSim::Framework::BasicThread | |
| Timer | m_timer |
| Timer to measure the actual time taken to doUpdate. | |
| std::shared_ptr< SurgSim::Framework::Logger > | m_logger |
| Logger for this thread. | |
Detailed Description
Manager to handle InputComponent and OutputComponent, SceneElement can add these to get input from devices, or even write output to devices.
The devices have to be added to this class before components can be added to it.
Member Function Documentation
§ addDevice()
| bool SurgSim::Input::InputManager::addDevice | ( | std::shared_ptr< SurgSim::Input::DeviceInterface > | device | ) |
Adds a device to the manager.
- Parameters
-
device The device.
- Returns
- true if it succeeds, false if the device already exists in the manager.
§ removeDevice()
| bool SurgSim::Input::InputManager::removeDevice | ( | std::shared_ptr< SurgSim::Input::DeviceInterface > | device | ) |
Removes the device described by device.
- Parameters
-
device The device.
- Returns
- true if it succeeds, false if the device is not in.
The documentation for this class was generated from the following files:
- SurgSim/Input/InputManager.h
- SurgSim/Input/InputManager.cpp
