Reordered argument handling
[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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifndef PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP
22 #define PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP
23
24 #include "device.hpp"
25
26 namespace sigrok {
27 class Context;
28 class HardwareDevice;
29 } // sigrok
30
31 namespace pv {
32 namespace devices {
33
34 class HardwareDevice final : public Device
35 {
36 public:
37         HardwareDevice(const std::shared_ptr<sigrok::Context> &context,
38                 std::shared_ptr<sigrok::HardwareDevice> device);
39
40         ~HardwareDevice();
41
42         std::shared_ptr<sigrok::HardwareDevice> hardware_device() const;
43
44         /**
45          * Builds the full name. It only contains all the fields.
46          */
47         std::string full_name() const;
48
49         /**
50          * Builds the display name. It only contains fields as required.
51          * @param device_manager a reference to the device manager is needed
52          * so that other similarly titled devices can be detected.
53          */
54         std::string display_name(const DeviceManager &device_manager) const;
55
56         void create();
57
58 private:
59         const std::shared_ptr<sigrok::Context> context_;
60 };
61
62 } // namespace devices
63 } // namespace pv
64
65 #endif // PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP