pv/views/trace/signal.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 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_VIEWS_TRACEVIEW_SIGNAL_HPP
  21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_SIGNAL_HPP
  22
  23 #include <memory>
  24
  25 #include <QComboBox>
  26 #include <QWidgetAction>
  27
  28 #include <cstdint>
  29
  30 #include <pv/data/logicsegment.hpp>
  31
  32 #include "trace.hpp"
  33 #include "viewitemowner.hpp"
  34
  35 using std::shared_ptr;
  36
  37 namespace pv {
  38
  39 class Session;
  40
  41 namespace data {
  42 class SignalBase;
  43 class SignalData;
  44 }
  45
  46 namespace views {
  47 namespace trace {
  48
  49 /**
  50  * The Signal class represents a series of numeric values that can be drawn.
  51  * This is the main difference to the more generic @ref Trace class.
  52  *
  53  * It is generally accepted that Signal instances consider themselves to be
  54  * individual channels on e.g. an oscilloscope, though it should be kept in
  55  * mind that virtual signals (e.g. math) will also be served by the Signal
  56  * class.
  57  */
  58 class Signal : public Trace, public ViewItemOwner
  59 {
  60         Q_OBJECT
  61
  62 protected:
  63         Signal(pv::Session &session, shared_ptr<data::SignalBase> channel);
  64
  65 public:
  66         /**
  67          * Sets the name of the signal.
  68          */
  69         virtual void set_name(QString name);
  70
  71         virtual shared_ptr<pv::data::SignalData> data() const = 0;
  72
  73         /**
  74          * Determines the closest level change (i.e. edge) to a given sample, which
  75          * is useful for e.g. the "snap to edge" functionality.
  76          *
  77          * @param sample_pos Sample to use
  78          * @return The changes left and right of the given position
  79          */
  80         virtual vector<data::LogicSegment::EdgePair> get_nearest_level_changes(uint64_t sample_pos) = 0;
  81
  82         /**
  83          * Returns true if the trace is visible and enabled.
  84          */
  85         bool enabled() const;
  86
  87         shared_ptr<data::SignalBase> base() const;
  88
  89         virtual void save_settings(QSettings &settings) const;
  90
  91         virtual void restore_settings(QSettings &settings);
  92
  93         void paint_back(QPainter &p, ViewItemPaintParams &pp);
  94
  95         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
  96
  97         QMenu* create_header_context_menu(QWidget *parent);
  98
  99         void delete_pressed();
 100
 101 protected Q_SLOTS:
 102         virtual void on_name_changed(const QString &text);
 103
 104         void on_disable();
 105
 106         void on_enabled_changed(bool enabled);
 107
 108 protected:
 109         pv::Session &session_;
 110
 111         QComboBox *name_widget_;
 112 };
 113
 114 } // namespace trace
 115 } // namespace views
 116 } // namespace pv
 117
 118 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_SIGNAL_HPP