license: remove FSF postal address from boiler plate license text
[pulseview.git] / pv / devices / file.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_FILE_HPP
21 #define PULSEVIEW_PV_DEVICES_FILE_HPP
22
23 #include <string>
24
25 #include "device.hpp"
26
27 namespace pv {
28 namespace devices {
29
30 class File : public Device
31 {
32 protected:
33         File(const std::string &file_name);
34
35 public:
36         /**
37          * Builds the full name. It only contains all the fields.
38          */
39         std::string full_name() const;
40
41         /**
42          * Builds the display name. It only contains fields as required.
43          */
44         std::string display_name(const DeviceManager&) const;
45
46 protected:
47         const std::string file_name_;
48 };
49
50 } // namespace devices
51 } // namespace pv
52
53 #endif // PULSEVIEW_PV_DEVICES_FILE_HPP