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