![]() |
Manager to handle InputComponent and OutputComponent, SceneElement can add these to get input from devices, or even write output to devices. More...
#include <SurgSim/Input/InputManager.h>
Public Member Functions | |
InputManager () | |
virtual | ~InputManager () |
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... | |
virtual int | getType () const override |
Returns the type of Manager. More... | |
![]() | |
ComponentManager (const std::string &name="Unknown Component Manager") | |
virtual | ~ComponentManager () |
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) |
![]() | |
BasicThread (const std::string &name="Unknown Thread") | |
virtual | ~BasicThread () noexcept(false) |
C++11 introduced noexcept. More... | |
void | start (std::shared_ptr< Barrier > startupBarrier=nullptr, bool isSynchronous=false) |
C++11 introduced noexcept. 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. More... | |
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... | |
Private Member Functions | |
virtual bool | doInitialize () override |
virtual bool | doStartUp () override |
virtual bool | doUpdate (double dt) override |
Implementation of actual work function for this thread, this has a default implementation to handle destruction better, as it could be called while the thread is under destruction, if left unimplemented this would trigger a call to a pure virtual function. More... | |
virtual 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 device. More... | |
virtual bool | executeRemovals (const std::shared_ptr< SurgSim::Framework::Component > &component) override |
Removes the component described by component. More... | |
bool | addInputComponent (const std::shared_ptr< InputComponent > &input) |
Specific call for input components. More... | |
bool | addOutputComponent (const std::shared_ptr< OutputComponent > &output) |
Specific call for output components. More... | |
Private Attributes | |
std::vector< std::shared_ptr< InputComponent > > | m_inputs |
Collection of all input components. More... | |
std::vector< std::shared_ptr< OutputComponent > > | m_outputs |
Collection of all output components. More... | |
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, no two devices with the same name can be added to the input manager. More... | |
boost::mutex | m_mutex |
Protect critical sections. More... | |
Friends | |
class | InputManagerTest |
Additional Inherited Members | |
![]() | |
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) |
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. More... | |
![]() | |
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) |
![]() | |
boost::mutex | m_componentMutex |
Blocks protects addition and removal queues. More... | |
std::shared_ptr< SurgSim::Framework::Logger > | m_logger |
Logger for this class. More... | |
std::vector< std::shared_ptr< SurgSim::Framework::Behavior > > | m_behaviors |
Collection of behaviors. More... | |
std::vector< std::shared_ptr< Component > > | m_componentAdditions |
std::vector< std::shared_ptr< Component > > | m_componentRemovals |
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.
SurgSim::Input::InputManager::InputManager | ( | ) |
|
virtual |
bool SurgSim::Input::InputManager::addDevice | ( | std::shared_ptr< SurgSim::Input::DeviceInterface > | device | ) |
Adds a device to the manager.
device | The device. |
|
private |
Specific call for input components.
Link input consumer to input device Data produced by device will then be consumed by input consumer
|
private |
Specific call for output components.
|
overrideprivatevirtual |
Implements SurgSim::Framework::BasicThread.
|
overrideprivatevirtual |
Implements SurgSim::Framework::BasicThread.
|
overrideprivatevirtual |
Implementation of actual work function for this thread, this has a default implementation to handle destruction better, as it could be called while the thread is under destruction, if left unimplemented this would trigger a call to a pure virtual function.
Reimplemented from SurgSim::Framework::BasicThread.
|
overrideprivatevirtual |
Adds a component, this can be either input or output, it will call the appropriate function in the device.
For an InputComonent this will succeed if the device name inside the component is known to the InputManager and if the component has not been added as an input yet. For an OutputComponent the call will fail if the device does not exist or the device has already been assigned an output.
component | The component. |
Implements SurgSim::Framework::ComponentManager.
|
overrideprivatevirtual |
Removes the component described by component.
component | The component. |
Implements SurgSim::Framework::ComponentManager.
|
overridevirtual |
Returns the type of Manager.
Implements SurgSim::Framework::ComponentManager.
bool SurgSim::Input::InputManager::removeDevice | ( | std::shared_ptr< SurgSim::Input::DeviceInterface > | device | ) |
Removes the device described by device.
device | The device. |
|
friend |
|
private |
Collection of all devices that have been added to the input manager key is the name, no two devices with the same name can be added to the input manager.
|
private |
Collection of all input components.
|
private |
Protect critical sections.
|
private |
Collection of all output components.