pv/device/devinst.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2014 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_DEVICE_DEVINST_H
  22 #define PULSEVIEW_PV_DEVICE_DEVINST_H
  23
  24 #include <map>
  25 #include <memory>
  26 #include <string>
  27
  28 #include <QObject>
  29
  30 #include <glib.h>
  31
  32 #include <stdint.h>
  33
  34 struct sr_dev_inst;
  35 struct sr_channel;
  36 struct sr_channel_group;
  37
  38 #include <pv/sigsession.h>
  39
  40 namespace pv {
  41
  42 namespace device {
  43
  44 class DevInst : public QObject
  45 {
  46         Q_OBJECT
  47
  48 protected:
  49         DevInst();
  50
  51 public:
  52         virtual sr_dev_inst* dev_inst() const = 0;
  53
  54         virtual void use(SigSession *owner) throw(QString);
  55
  56         virtual void release();
  57
  58         SigSession* owner() const;
  59
  60         virtual std::string format_device_title() const = 0;
  61
  62         virtual std::map<std::string, std::string> get_device_info() const = 0;
  63
  64         GVariant* get_config(const sr_channel_group *group, int key);
  65
  66         bool set_config(const sr_channel_group *group, int key, GVariant *data);
  67
  68         GVariant* list_config(const sr_channel_group *group, int key);
  69
  70         void enable_channel(const sr_channel *channel, bool enable = true);
  71
  72         /**
  73          * @brief Gets the sample limit from the driver.
  74          *
  75          * @return The returned sample limit from the driver, or 0 if the
  76          *      sample limit could not be read.
  77          */
  78         uint64_t get_sample_limit();
  79
  80         virtual bool is_trigger_enabled() const;
  81
  82 public:
  83         virtual void start();
  84
  85         virtual void run();
  86
  87 Q_SIGNALS:
  88         void config_changed();
  89
  90 protected:
  91         SigSession *_owner;
  92 };
  93
  94 } // device
  95 } // pv
  96
  97 #endif // PULSEVIEW_PV_DEVICE_DEVINST_H