9621f35117bd47a702eb9e397afa7e8a54fc9d7c
[pulseview.git] / pv / views / viewbase.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5  * Copyright (C) 2016 Soeren Apel <soeren@apelpie.net>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef PULSEVIEW_PV_VIEWS_VIEWBASE_HPP
22 #define PULSEVIEW_PV_VIEWS_VIEWBASE_HPP
23
24 #include <cstdint>
25 #include <memory>
26 #include <unordered_set>
27 #include <vector>
28
29 #include <QMainWindow>
30 #include <QTimer>
31 #include <QWidget>
32
33 #include <pv/data/signalbase.hpp>
34 #include <pv/util.hpp>
35
36 #ifdef ENABLE_DECODE
37 #include <pv/data/decodesignal.hpp>
38 #endif
39
40 using std::shared_ptr;
41 using std::unordered_set;
42
43 namespace pv {
44
45 class Session;
46
47 namespace view {
48 class DecodeTrace;
49 class Signal;
50 }
51
52 namespace views {
53
54 // When adding an entry here, don't forget to update ViewTypeNames as well
55 enum ViewType {
56         ViewTypeTrace,
57 #ifdef ENABLE_DECODE
58         ViewTypeDecoderOutput,
59 #endif
60         ViewTypeCount  // Indicates how many view types there are, must always be last
61 };
62
63 extern const char* ViewTypeNames[ViewTypeCount];
64
65 class ViewBase : public QWidget
66 {
67         Q_OBJECT
68
69 private:
70         static const int MaxViewAutoUpdateRate;
71
72 public:
73         explicit ViewBase(Session &session, bool is_main_view = false, QMainWindow *parent = nullptr);
74
75         virtual ViewType get_type() const = 0;
76         bool is_main_view() const;
77
78         /**
79          * Resets the view to its default state after construction. It does however
80          * not reset the signal bases or any other connections with the session.
81          */
82         virtual void reset_view_state();
83
84         Session& session();
85         const Session& session() const;
86
87         virtual void clear_signals();
88
89         /**
90          * Returns the signal bases contained in this view.
91          */
92         unordered_set< shared_ptr<data::SignalBase> > signalbases() const;
93
94         virtual void clear_signalbases();
95
96         virtual void add_signalbase(const shared_ptr<data::SignalBase> signalbase);
97
98 #ifdef ENABLE_DECODE
99         virtual void clear_decode_signals();
100
101         virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
102
103         virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
104 #endif
105
106         virtual void save_settings(QSettings &settings) const;
107
108         virtual void restore_settings(QSettings &settings);
109
110 public Q_SLOTS:
111         virtual void trigger_event(int segment_id, util::Timestamp location);
112         virtual void signals_changed();
113         virtual void capture_state_updated(int state);
114         virtual void on_new_segment(int new_segment_id);
115         virtual void on_segment_completed(int new_segment_id);
116         virtual void perform_delayed_view_update();
117
118 private Q_SLOTS:
119         void on_samples_added(uint64_t segment_id, uint64_t start_sample,
120                 uint64_t end_sample);
121
122         void on_data_updated();
123
124 protected:
125         Session &session_;
126
127         const bool is_main_view_;
128
129         util::TimeUnit time_unit_;
130
131         unordered_set< shared_ptr<data::SignalBase> > signalbases_;
132 #ifdef ENABLE_DECODE
133         unordered_set< shared_ptr<data::DecodeSignal> > decode_signals_;
134 #endif
135
136         /// The ID of the currently displayed segment
137         uint32_t current_segment_;
138
139         QTimer delayed_view_updater_;
140 };
141
142 } // namespace views
143 } // namespace pv
144
145 #endif // PULSEVIEW_PV_VIEWS_VIEWBASE_HPP