manual: Bump date to the date of the last change.
[pulseview.git] / pv / views / viewbase.cpp
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 #ifdef ENABLE_DECODE
22 #include <libsigrokdecode/libsigrokdecode.h>
23 #endif
24
25 #include <libsigrokcxx/libsigrokcxx.hpp>
26
27 #include "pv/session.hpp"
28 #include "pv/util.hpp"
29 #include "pv/data/segment.hpp"
30
31 using std::shared_ptr;
32
33 namespace pv {
34 namespace views {
35
36 const char* ViewTypeNames[ViewTypeCount] = {
37         "Trace View",
38 #ifdef ENABLE_DECODE
39         "Decoder Output View"
40 #endif
41 };
42
43 const int ViewBase::MaxViewAutoUpdateRate = 25; // No more than 25 Hz
44
45 ViewBase::ViewBase(Session &session, bool is_main_view, QMainWindow *parent) :
46         // Note: Place defaults in ViewBase::reset_view_state(), not here
47         QWidget(parent),
48         session_(session),
49         is_main_view_(is_main_view)
50 {
51         (void)parent;
52
53         connect(&session_, SIGNAL(signals_changed()),
54                 this, SLOT(signals_changed()));
55         connect(&session_, SIGNAL(capture_state_changed(int)),
56                 this, SLOT(capture_state_updated(int)));
57         connect(&session_, SIGNAL(new_segment(int)),
58                 this, SLOT(on_new_segment(int)));
59
60         connect(&delayed_view_updater_, SIGNAL(timeout()),
61                 this, SLOT(perform_delayed_view_update()));
62         delayed_view_updater_.setSingleShot(true);
63         delayed_view_updater_.setInterval(1000 / MaxViewAutoUpdateRate);
64 }
65
66 bool ViewBase::is_main_view() const
67 {
68         return is_main_view_;
69 }
70
71 void ViewBase::reset_view_state()
72 {
73         current_segment_ = 0;
74 }
75
76 Session& ViewBase::session()
77 {
78         return session_;
79 }
80
81 const Session& ViewBase::session() const
82 {
83         return session_;
84 }
85
86 void ViewBase::clear_signals()
87 {
88         clear_signalbases();
89 }
90
91 unordered_set< shared_ptr<data::SignalBase> > ViewBase::signalbases() const
92 {
93         return signalbases_;
94 }
95
96 void ViewBase::clear_signalbases()
97 {
98         for (const shared_ptr<data::SignalBase>& signalbase : signalbases_) {
99                 disconnect(signalbase.get(), SIGNAL(samples_cleared()),
100                         this, SLOT(on_data_updated()));
101                 disconnect(signalbase.get(), SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
102                         this, SLOT(on_samples_added(uint64_t, uint64_t, uint64_t)));
103         }
104
105         signalbases_.clear();
106 }
107
108 void ViewBase::add_signalbase(const shared_ptr<data::SignalBase> signalbase)
109 {
110         signalbases_.insert(signalbase);
111
112         connect(signalbase.get(), SIGNAL(samples_cleared()),
113                 this, SLOT(on_data_updated()));
114         connect(signalbase.get(), SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
115                 this, SLOT(on_samples_added(uint64_t, uint64_t, uint64_t)));
116 }
117
118 #ifdef ENABLE_DECODE
119 void ViewBase::clear_decode_signals()
120 {
121         decode_signals_.clear();
122 }
123
124 void ViewBase::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
125 {
126         decode_signals_.insert(signal);
127 }
128
129 void ViewBase::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
130 {
131         decode_signals_.erase(signal);
132 }
133 #endif
134
135 void ViewBase::save_settings(QSettings &settings) const
136 {
137         (void)settings;
138 }
139
140 void ViewBase::restore_settings(QSettings &settings)
141 {
142         (void)settings;
143 }
144
145 void ViewBase::trigger_event(int segment_id, util::Timestamp location)
146 {
147         (void)segment_id;
148         (void)location;
149 }
150
151 void ViewBase::signals_changed()
152 {
153 }
154
155 void ViewBase::on_new_segment(int new_segment_id)
156 {
157         (void)new_segment_id;
158 }
159
160 void ViewBase::on_segment_completed(int new_segment_id)
161 {
162         (void)new_segment_id;
163 }
164
165 void ViewBase::capture_state_updated(int state)
166 {
167         (void)state;
168 }
169
170 void ViewBase::perform_delayed_view_update()
171 {
172 }
173
174 void ViewBase::on_samples_added(uint64_t segment_id, uint64_t start_sample,
175         uint64_t end_sample)
176 {
177         (void)start_sample;
178         (void)end_sample;
179
180         if (segment_id != current_segment_)
181                 return;
182
183         if (!delayed_view_updater_.isActive())
184                 delayed_view_updater_.start();
185 }
186
187 void ViewBase::on_data_updated()
188 {
189         if (!delayed_view_updater_.isActive())
190                 delayed_view_updater_.start();
191 }
192
193 }  // namespace views
194 } // namespace pv