DecoderSelector: Properly name utility methods
[pulseview.git] / pv / devices / hardwaredevice.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2015 Joel Holdsworth <joel@airwebreathe.org.uk>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP
21 #define PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP
22
23 #include "device.hpp"
24
25 using std::shared_ptr;
26 using std::string;
27
28 namespace sigrok {
29 class Context;
30 class HardwareDevice;
31 } // sigrok
32
33 namespace pv {
34 namespace devices {
35
36 class HardwareDevice final : public Device
37 {
38 public:
39         HardwareDevice(const shared_ptr<sigrok::Context> &context,
40                 shared_ptr<sigrok::HardwareDevice> device);
41
42         ~HardwareDevice();
43
44         shared_ptr<sigrok::HardwareDevice> hardware_device() const;
45
46         /**
47          * Builds the full name. It only contains all the fields.
48          */
49         string full_name() const;
50
51         /**
52          * Builds the display name. It only contains fields as required.
53          * @param device_manager a reference to the device manager is needed
54          * so that other similarly titled devices can be detected.
55          */
56         string display_name(const DeviceManager &device_manager) const;
57
58         void open();
59
60         void close();
61
62 private:
63         const shared_ptr<sigrok::Context> context_;
64         bool device_open_;
65 };
66
67 } // namespace devices
68 } // namespace pv
69
70 #endif // PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP