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 namespace sigrok {
  26 class Context;
  27 class HardwareDevice;
  28 } // sigrok
  29
  30 namespace pv {
  31 namespace devices {
  32
  33 class HardwareDevice final : public Device
  34 {
  35 public:
  36         HardwareDevice(const std::shared_ptr<sigrok::Context> &context,
  37                 std::shared_ptr<sigrok::HardwareDevice> device);
  38
  39         ~HardwareDevice();
  40
  41         std::shared_ptr<sigrok::HardwareDevice> hardware_device() const;
  42
  43         /**
  44          * Builds the full name. It only contains all the fields.
  45          */
  46         std::string full_name() const;
  47
  48         /**
  49          * Builds the display name. It only contains fields as required.
  50          * @param device_manager a reference to the device manager is needed
  51          * so that other similarly titled devices can be detected.
  52          */
  53         std::string display_name(const DeviceManager &device_manager) const;
  54
  55         void open();
  56
  57         void close();
  58
  59 private:
  60         const std::shared_ptr<sigrok::Context> context_;
  61         bool device_open_;
  62 };
  63
  64 } // namespace devices
  65 } // namespace pv
  66
  67 #endif // PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP