DecodeTrace: Rename get_sample_range() to get_view_sample_range()
[pulseview.git] / 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 "trace.hpp"
31 #include "viewitemowner.hpp"
32
33 using std::shared_ptr;
34
35 namespace pv {
36
37 class Session;
38
39 namespace data {
40 class SignalBase;
41 class SignalData;
42 }
43
44 namespace views {
45 namespace trace {
46
47 /**
48  * The Signal class represents a series of numeric values that can be drawn.
49  * This is the main difference to the more generic @ref Trace class.
50  *
51  * It is generally accepted that Signal instances consider themselves to be
52  * individual channels on e.g. an oscilloscope, though it should be kept in
53  * mind that virtual signals (e.g. math) will also be served by the Signal
54  * class.
55  */
56 class Signal : public Trace, public ViewItemOwner
57 {
58         Q_OBJECT
59
60 protected:
61         Signal(pv::Session &session, shared_ptr<data::SignalBase> channel);
62
63 public:
64         /**
65          * Sets the name of the signal.
66          */
67         virtual void set_name(QString name);
68
69         virtual shared_ptr<pv::data::SignalData> data() const = 0;
70
71         /**
72          * Returns true if the trace is visible and enabled.
73          */
74         bool enabled() const;
75
76         shared_ptr<data::SignalBase> base() const;
77
78         virtual void save_settings(QSettings &settings) const;
79
80         virtual void restore_settings(QSettings &settings);
81
82         void paint_back(QPainter &p, ViewItemPaintParams &pp);
83
84         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
85
86         QMenu* create_header_context_menu(QWidget *parent);
87
88         void delete_pressed();
89
90 protected Q_SLOTS:
91         virtual void on_name_changed(const QString &text);
92
93         void on_disable();
94
95         void on_enabled_changed(bool enabled);
96
97 protected:
98         pv::Session &session_;
99
100         QComboBox *name_widget_;
101 };
102
103 } // namespace trace
104 } // namespace views
105 } // namespace pv
106
107 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_SIGNAL_HPP