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