]>
Commit | Line | Data |
---|---|---|
da30ecb7 JH |
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 | |
efdec55a | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
da30ecb7 JH |
18 | */ |
19 | ||
20 | #ifndef PULSEVIEW_PV_DEVICES_DEVICE_HPP | |
21 | #define PULSEVIEW_PV_DEVICES_DEVICE_HPP | |
22 | ||
23 | #include <memory> | |
b485408f | 24 | #include <string> |
da30ecb7 JH |
25 | |
26 | namespace sigrok { | |
b48daed6 | 27 | class ConfigKey; |
da30ecb7 JH |
28 | class Device; |
29 | class Session; | |
30 | } // namespace sigrok | |
31 | ||
32 | namespace pv { | |
b485408f JH |
33 | |
34 | class DeviceManager; | |
35 | ||
da30ecb7 JH |
36 | namespace devices { |
37 | ||
38 | class Device | |
39 | { | |
40 | protected: | |
41 | Device(); | |
42 | ||
43 | public: | |
44 | virtual ~Device(); | |
45 | ||
46 | std::shared_ptr<sigrok::Session> session() const; | |
47 | ||
48 | std::shared_ptr<sigrok::Device> device() const; | |
49 | ||
b48daed6 JH |
50 | template<typename T> |
51 | T read_config(const sigrok::ConfigKey *key, const T default_value = 0); | |
52 | ||
b485408f JH |
53 | /** |
54 | * Builds the full name. It only contains all the fields. | |
55 | */ | |
56 | virtual std::string full_name() const = 0; | |
57 | ||
58 | /** | |
59 | * Builds the display name. It only contains fields as required. | |
60 | * @param device_manager a reference to the device manager is needed | |
61 | * so that other similarly titled devices can be detected. | |
62 | */ | |
63 | virtual std::string display_name( | |
64 | const DeviceManager &device_manager) const = 0; | |
65 | ||
4d6c6ea3 SA |
66 | virtual void open() = 0; |
67 | ||
68 | virtual void close() = 0; | |
da30ecb7 | 69 | |
5237f0c5 JH |
70 | virtual void start(); |
71 | ||
da30ecb7 JH |
72 | virtual void run(); |
73 | ||
74 | virtual void stop(); | |
75 | ||
76 | protected: | |
77 | std::shared_ptr<sigrok::Session> session_; | |
78 | std::shared_ptr<sigrok::Device> device_; | |
79 | }; | |
80 | ||
81 | } // namespace devices | |
82 | } // namespace pv | |
83 | ||
84 | #endif // PULSEVIEW_PV_DEVICES_DEVICE_HPP |