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