All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
IdentityPoseDevice.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_IDENTITYPOSEDEVICE_IDENTITYPOSEDEVICE_H
17 #define SURGSIM_DEVICES_IDENTITYPOSEDEVICE_IDENTITYPOSEDEVICE_H
18 
19 #include <memory>
20 #include <string>
21 
23 
24 namespace SurgSim
25 {
26 namespace Device
27 {
28 
29 
39 {
40 public:
43  explicit IdentityPoseDevice(const std::string& uniqueName);
44 
45  virtual bool addInputConsumer(std::shared_ptr<SurgSim::Input::InputConsumerInterface> inputConsumer);
46 
47 protected:
48  virtual bool initialize();
49 
50  virtual bool finalize();
51 
54 };
55 
56 
57 }; // namespace Device
58 }; // namespace SurgSim
59 
60 #endif // SURGSIM_DEVICES_IDENTITYPOSEDEVICE_IDENTITYPOSEDEVICE_H
virtual bool initialize()
Fully initialize the device.
Definition: IdentityPoseDevice.cpp:45
virtual bool finalize()
Finalize (de-initialize) the device.
Definition: IdentityPoseDevice.cpp:51
A class implementing the identity pose device, which is a pretend device that doesn't move...
Definition: IdentityPoseDevice.h:38
static SurgSim::DataStructures::DataGroup buildInputData()
Builds the data layout for the application input (i.e. device output).
Definition: IdentityPoseDevice.cpp:57
virtual bool addInputConsumer(std::shared_ptr< SurgSim::Input::InputConsumerInterface > inputConsumer)
Connect this device to an InputConsumerInterface, which will receive the data that comes from this de...
Definition: IdentityPoseDevice.cpp:65
A collection of NamedData objects.
Definition: DataGroup.h:66
A class that implements some common management code on top of the DeviceInterface.
Definition: CommonDevice.h:34
IdentityPoseDevice(const std::string &uniqueName)
Constructor.
Definition: IdentityPoseDevice.cpp:40