2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef PULSEVIEW_PV_VIEW_VIEW_HPP
22 #define PULSEVIEW_PV_VIEW_VIEW_HPP
29 #include <unordered_map>
32 #include <QAbstractScrollArea>
36 #include <pv/data/signaldata.hpp>
37 #include <pv/util.hpp>
39 #include "cursorpair.hpp"
41 #include "tracetreeitemowner.hpp"
61 class View : public QAbstractScrollArea, public TraceTreeItemOwner {
66 TraceTreeItemHExtentsChanged = 1,
67 TraceTreeItemVExtentsChanged = 2
71 static const pv::util::Timestamp MaxScale;
72 static const pv::util::Timestamp MinScale;
74 static const int MaxScrollValue;
75 static const int MaxViewAutoUpdateRate;
77 static const int ScaleUnits[3];
80 explicit View(Session &session, QWidget *parent = 0);
83 const Session& session() const;
86 * Returns the signals contained in this view.
88 std::unordered_set< std::shared_ptr<view::Signal> > signals() const;
92 void add_signal(const std::shared_ptr<view::Signal> signal);
95 * Returns the view of the owner.
97 virtual pv::view::View* view();
100 * Returns the view of the owner.
102 virtual const pv::view::View* view() const;
104 Viewport* viewport();
106 const Viewport* viewport() const;
109 * Gets a list of time markers.
111 std::vector< std::shared_ptr<TimeItem> > time_items() const;
114 * Returns the view time scale in seconds per pixel.
116 double scale() const;
119 * Returns the time offset of the left edge of the view in
122 const pv::util::Timestamp& offset() const;
125 * Returns the vertical scroll offset.
127 int owner_visual_v_offset() const;
130 * Sets the visual v-offset.
132 void set_v_offset(int offset);
135 * Returns the SI prefix to apply to the graticule time markings.
137 pv::util::SIPrefix tick_prefix() const;
140 * Returns the number of fractional digits shown for the time markings.
142 unsigned int tick_precision() const;
145 * Returns period of the graticule time markings.
147 const pv::util::Timestamp& tick_period() const;
150 * Returns the unit of time currently used.
152 util::TimeUnit time_unit() const;
155 * Returns the number of nested parents that this row item owner has.
157 unsigned int depth() const;
159 void zoom(double steps);
160 void zoom(double steps, int offset);
162 void zoom_fit(bool gui_state);
164 void zoom_one_to_one();
167 * Sets the scale and offset.
168 * @param scale The new view scale in seconds per pixel.
169 * @param offset The view time offset in seconds.
171 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
173 std::set< std::shared_ptr<pv::data::SignalData> >
174 get_visible_data() const;
176 std::pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
179 * Enables or disables sticky scrolling, i.e. the view always shows
180 * the most recent samples when capturing data.
182 void enable_sticky_scrolling(bool state);
185 * Enables or disables coloured trace backgrounds. If they're not
186 * coloured then they will use alternating colors.
188 void enable_coloured_bg(bool state);
191 * Returns true if cursors are displayed. false otherwise.
193 bool cursors_shown() const;
196 * Shows or hides the cursors.
198 void show_cursors(bool show = true);
201 * Moves the cursors to a convenient position in the view.
203 void centre_cursors();
206 * Returns a reference to the pair of cursors.
208 std::shared_ptr<CursorPair> cursors() const;
211 * Adds a new flag at a specified time.
213 void add_flag(const pv::util::Timestamp& time);
216 * Removes a flag from the list.
218 void remove_flag(std::shared_ptr<Flag> flag);
221 * Gets the list of flags.
223 std::vector< std::shared_ptr<Flag> > flags() const;
225 const QPoint& hover_point() const;
227 void restack_all_trace_tree_items();
230 void hover_point_changed();
232 void selection_changed();
234 /// Emitted when the offset changed.
235 void offset_changed();
237 /// Emitted when the scale changed.
238 void scale_changed();
240 void sticky_scrolling_changed(bool state);
242 void always_zoom_to_fit_changed(bool state);
244 /// Emitted when the tick_prefix changed.
245 void tick_prefix_changed();
247 /// Emitted when the tick_precision changed.
248 void tick_precision_changed();
250 /// Emitted when the tick_period changed.
251 void tick_period_changed();
253 /// Emitted when the time_unit changed.
254 void time_unit_changed();
257 void trigger_event(util::Timestamp location);
260 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
263 * Simultaneously sets the zoom and offset.
264 * @param scale The scale to set the view to in seconds per pixel. This
265 * value is clamped between MinScale and MaxScale.
266 * @param offset The offset of the left edge of the view in seconds.
268 void set_zoom(double scale, int offset);
271 * Find a tick spacing and number formatting that does not cause
272 * the values to collide.
274 void calculate_tick_spacing();
276 void update_scroll();
280 void set_scroll_default();
282 void update_layout();
284 TraceTreeItemOwner* find_prevalent_trace_group(
285 const std::shared_ptr<sigrok::ChannelGroup> &group,
286 const std::unordered_map<std::shared_ptr<data::SignalBase>,
287 std::shared_ptr<Signal> > &signal_map);
289 static std::vector< std::shared_ptr<Trace> >
290 extract_new_traces_for_channels(
291 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
292 const std::unordered_map<std::shared_ptr<data::SignalBase>,
293 std::shared_ptr<Signal> > &signal_map,
294 std::set< std::shared_ptr<Trace> > &add_list);
296 void determine_time_unit();
298 bool eventFilter(QObject *object, QEvent *event);
300 bool viewportEvent(QEvent *event);
302 void resizeEvent(QResizeEvent *event);
305 void row_item_appearance_changed(bool label, bool content);
306 void time_item_appearance_changed(bool label, bool content);
308 void extents_changed(bool horz, bool vert);
312 void h_scroll_value_changed(int value);
313 void v_scroll_value_changed();
315 void signals_changed();
316 void capture_state_updated(int state);
319 void perform_delayed_view_update();
321 void process_sticky_events();
323 void on_hover_point_changed();
326 * Sets the 'offset_' member and emits the 'offset_changed'
329 void set_offset(const pv::util::Timestamp& offset);
332 * Sets the 'scale_' member and emits the 'scale_changed'
335 void set_scale(double scale);
338 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
341 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
344 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
347 void set_tick_precision(unsigned tick_precision);
350 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
353 void set_tick_period(const pv::util::Timestamp& tick_period);
356 * Sets the 'time_unit' member and emits the 'time_unit_changed'
359 void set_time_unit(pv::util::TimeUnit time_unit);
368 std::unordered_set< std::shared_ptr<view::Signal> > signals_;
370 /// The view time scale in seconds per pixel.
373 /// The view time offset in seconds.
374 pv::util::Timestamp offset_;
376 bool updating_scroll_;
377 bool sticky_scrolling_;
378 bool always_zoom_to_fit_;
379 QTimer delayed_view_updater_;
381 pv::util::Timestamp tick_period_;
382 pv::util::SIPrefix tick_prefix_;
383 unsigned int tick_precision_;
384 util::TimeUnit time_unit_;
387 std::shared_ptr<CursorPair> cursors_;
389 std::list< std::shared_ptr<Flag> > flags_;
390 char next_flag_text_;
392 std::vector< std::shared_ptr<TriggerMarker> > trigger_markers_;
396 unsigned int sticky_events_;
397 QTimer lazy_event_handler_;
399 // This is true when the defaults couldn't be set due to insufficient info
400 bool scroll_needs_defaults;
406 #endif // PULSEVIEW_PV_VIEW_VIEW_HPP