DeviceFilter.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_DEVICES_DEVICEFILTERS_DEVICEFILTER_H
17 #define SURGSIM_DEVICES_DEVICEFILTERS_DEVICEFILTER_H
18 
19 #include <string>
20 
24 
25 namespace SurgSim
26 {
27 namespace DataStructures
28 {
29 class DataGroup;
30 }
31 
32 namespace Devices
33 {
34 
37 class DeviceFilter :
39 {
40 public:
43  explicit DeviceFilter(const std::string& name);
44 
46 
47  bool initialize() override;
48 
49  bool isInitialized() const override;
50 
51  void initializeInput(const std::string& device, const DataStructures::DataGroup& inputData) override;
52 
53  void handleInput(const std::string& device, const DataStructures::DataGroup& inputData) override;
54 
55  bool requestOutput(const std::string& device, DataStructures::DataGroup* outputData) override;
56 
57 protected:
63  virtual void filterInput(const std::string& device, const DataStructures::DataGroup& dataToFilter,
65 
71  virtual void filterOutput(const std::string& device, const DataStructures::DataGroup& dataToFilter,
73 
74 protected:
75  bool finalize() override;
76 
79 };
80 
81 }; // namespace Devices
82 }; // namespace SurgSim
83 
84 #endif // SURGSIM_DEVICES_DEVICEFILTERS_DEVICEFILTER_H
SurgSim::Devices::DeviceFilter::DeviceFilter
DeviceFilter(const std::string &name)
Constructor.
Definition: DeviceFilter.cpp:27
SurgSim::Devices::DeviceFilter::requestOutput
bool requestOutput(const std::string &device, DataStructures::DataGroup *outputData) override
Asks the producer to provide output state to the device.
Definition: DeviceFilter.cpp:61
SurgSim::Devices::DeviceFilter::m_initialized
bool m_initialized
true if initialized and not finalized.
Definition: DeviceFilter.h:78
SurgSim::Devices::DeviceFilter::handleInput
void handleInput(const std::string &device, const DataStructures::DataGroup &inputData) override
Notifies the consumer that the application input coming from the device has been updated.
Definition: DeviceFilter.cpp:55
InputConsumerInterface.h
SurgSim::Devices::DeviceFilter::SURGSIM_CLASSNAME
SURGSIM_CLASSNAME(SurgSim::Devices::DeviceFilter)
SurgSim::Devices::DeviceFilter
A device filter can be connected between a device and the InputConsumerInterface (e....
Definition: DeviceFilter.h:39
SurgSim
Definition: CompoundShapeToGraphics.cpp:30
SurgSim::Input::CommonDevice
A class that implements some common management code on top of the DeviceInterface.
Definition: CommonDevice.h:36
SurgSim::DataStructures::DataGroup
A collection of NamedData objects.
Definition: DataGroup.h:69
SurgSim::Devices::DeviceFilter::finalize
bool finalize() override
Finalize (de-initialize) the device.
Definition: DeviceFilter.cpp:38
SurgSim::Input::OutputProducerInterface
Interface for a producer that generates device output updates (forces, status LED state,...
Definition: OutputProducerInterface.h:34
SurgSim::Input::InputConsumerInterface
Interface for a consumer that monitors device and signal state updates (pose, buttons,...
Definition: InputConsumerInterface.h:34
SurgSim::Devices::DeviceFilter::initializeInput
void initializeInput(const std::string &device, const DataStructures::DataGroup &inputData) override
Set the initial input data group.
Definition: DeviceFilter.cpp:50
CommonDevice.h
SurgSim::Devices::DeviceFilter::initialize
bool initialize() override
Fully initialize the device.
Definition: DeviceFilter.cpp:31
SurgSim::Devices::DeviceFilter::filterOutput
virtual void filterOutput(const std::string &device, const DataStructures::DataGroup &dataToFilter, DataStructures::DataGroup *result)
Filter the output data.
Definition: DeviceFilter.cpp:76
SurgSim::Devices::DeviceFilter::isInitialized
bool isInitialized() const override
Definition: DeviceFilter.cpp:45
SurgSim::Devices::DeviceFilter::filterInput
virtual void filterInput(const std::string &device, const DataStructures::DataGroup &dataToFilter, DataStructures::DataGroup *result)
Filter the input data.
Definition: DeviceFilter.cpp:71
OutputProducerInterface.h
string
string(TOUPPER ${DEVICE} DEVICE_UPPER_CASE) option(BUILD_DEVICE_$
Definition: CMakeLists.txt:38