GNU Radio Manual and C++ API Reference 3.10.3.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
time_sink_f.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2011-2013,2015 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_QTGUI_TIME_SINK_F_H
12#define INCLUDED_QTGUI_TIME_SINK_F_H
13
14#ifdef ENABLE_PYTHON
15#include <Python.h>
16#endif
17
18#include <gnuradio/qtgui/api.h>
20#include <gnuradio/sync_block.h>
21#include <qapplication.h>
22
23namespace gr {
24namespace qtgui {
25
26/*!
27 * \brief A graphical sink to display multiple signals in time.
28 * \ingroup instrumentation_blk
29 * \ingroup qtgui_blk
30 *
31 * \details
32 * This is a QT-based graphical sink the takes set of a float streams
33 * and plots them in the time domain. Each signal is plotted with a
34 * different color, and the \a set_title and \a set_color functions
35 * can be used to change the label and color for a given input number.
36 *
37 * The sink supports plotting streaming float data or
38 * messages. The message port is named "in". The two modes cannot
39 * be used simultaneously, and \p nconnections should be set to 0
40 * when using the message mode. GRC handles this issue by
41 * providing the "Float Message" type that removes the streaming
42 * port(s).
43 *
44 * This sink can plot messages that contain either uniform vectors
45 * of float 32 values (pmt::is_f32vector) or PDUs where the data
46 * is a uniform vector of float 32 values.
47 */
48class QTGUI_API time_sink_f : virtual public sync_block
49{
50public:
51 // gr::qtgui::time_sink_f::sptr
52 typedef std::shared_ptr<time_sink_f> sptr;
53
54 /*!
55 * \brief Build floating point time sink
56 *
57 * \param size number of points to plot at once
58 * \param samp_rate sample rate (used to set x-axis labels)
59 * \param name title for the plot
60 * \param nconnections number of signals connected to sink
61 * \param parent a QWidget parent object, if any
62 */
63 static sptr make(int size,
64 double samp_rate,
65 const std::string& name,
66 unsigned int nconnections = 1,
67 QWidget* parent = NULL);
68
69 virtual void exec_() = 0;
70 virtual QWidget* qwidget() = 0;
71
72 virtual void set_y_axis(double min, double max) = 0;
73 virtual void set_y_label(const std::string& label, const std::string& unit = "") = 0;
74 virtual void set_update_time(double t) = 0;
75 virtual void set_title(const std::string& title) = 0;
76 virtual void set_line_label(unsigned int which, const std::string& line) = 0;
77 virtual void set_line_color(unsigned int which, const std::string& color) = 0;
78 virtual void set_line_width(unsigned int which, int width) = 0;
79 virtual void set_line_style(unsigned int which, int style) = 0;
80 virtual void set_line_marker(unsigned int which, int marker) = 0;
81 virtual void set_nsamps(const int newsize) = 0;
82 virtual void set_samp_rate(const double samp_rate) = 0;
83 virtual void set_line_alpha(unsigned int which, double alpha) = 0;
84
85 /*!
86 * Set up a trigger for the sink to know when to start
87 * plotting. Useful to isolate events and avoid noise.
88 *
89 * The trigger modes are Free, Auto, Normal, and Tag (see
90 * gr::qtgui::trigger_mode). The first three are like a normal
91 * oscope trigger function. Free means free running with no
92 * trigger, auto will trigger if the trigger event is seen, but
93 * will still plot otherwise, and normal will hold until the
94 * trigger event is observed. The Tag trigger mode allows us to
95 * trigger off a specific stream tag. The tag trigger is based
96 * only on the name of the tag, so when a tag of the given name
97 * is seen, the trigger is activated.
98 *
99 * In auto and normal mode, we look for the slope of the of the
100 * signal. Given a gr::qtgui::trigger_slope as either Positive
101 * or Negative, if the value between two samples moves in the
102 * given direction (x[1] > x[0] for Positive or x[1] < x[0] for
103 * Negative), then the trigger is activated.
104 *
105 * The \p delay value is specified in time based off the sample
106 * rate. If the sample rate of the block is set to 1, the delay
107 * is then also the sample number offset. This is the offset
108 * from the left-hand y-axis of the plot. It delays the signal
109 * to show the trigger event at the given delay along with some
110 * portion of the signal before the event. The delay must be
111 * within 0 - t_max where t_max is the maximum amount of time
112 * displayed on the time plot.
113 *
114 * \param mode The trigger_mode: free, auto, normal, or tag.
115 * \param slope The trigger_slope: positive or negative. Only
116 * used for auto and normal modes.
117 * \param level The magnitude of the trigger even for auto or normal modes.
118 * \param delay The delay (in units of time) for where the trigger happens.
119 * \param channel Which input channel to use for the trigger events.
120 * \param tag_key The name (as a string) of the tag to trigger off
121 * of if using the tag mode.
122 */
124 trigger_slope slope,
125 float level,
126 float delay,
127 int channel,
128 const std::string& tag_key = "") = 0;
129
130 virtual std::string title() = 0;
131 virtual std::string line_label(unsigned int which) = 0;
132 virtual std::string line_color(unsigned int which) = 0;
133 virtual int line_width(unsigned int which) = 0;
134 virtual int line_style(unsigned int which) = 0;
135 virtual int line_marker(unsigned int which) = 0;
136 virtual double line_alpha(unsigned int which) = 0;
137
138 virtual void set_size(int width, int height) = 0;
139
140 virtual void enable_menu(bool en = true) = 0;
141 virtual void enable_grid(bool en = true) = 0;
142 virtual void enable_autoscale(bool en = true) = 0;
143 virtual void enable_stem_plot(bool en = true) = 0;
144 virtual void enable_semilogx(bool en = true) = 0;
145 virtual void enable_semilogy(bool en = true) = 0;
146 virtual void enable_control_panel(bool en = true) = 0;
147 virtual void enable_tags(unsigned int which, bool en) = 0;
148 virtual void enable_tags(bool en) = 0;
149 virtual void enable_axis_labels(bool en = true) = 0;
150 virtual void disable_legend() = 0;
151
152 virtual int nsamps() const = 0;
153 virtual void reset() = 0;
154
155 QApplication* d_qApplication;
156};
157
158} /* namespace qtgui */
159} /* namespace gr */
160
161#endif /* INCLUDED_QTGUI_TIME_SINK_F_H */
A graphical sink to display multiple signals in time.
Definition: time_sink_f.h:49
virtual void set_samp_rate(const double samp_rate)=0
virtual void set_line_label(unsigned int which, const std::string &line)=0
std::shared_ptr< time_sink_f > sptr
Definition: time_sink_f.h:52
virtual void enable_tags(bool en)=0
virtual void set_line_alpha(unsigned int which, double alpha)=0
virtual void reset()=0
virtual void set_nsamps(const int newsize)=0
virtual void enable_autoscale(bool en=true)=0
virtual int nsamps() const =0
static sptr make(int size, double samp_rate, const std::string &name, unsigned int nconnections=1, QWidget *parent=NULL)
Build floating point time sink.
virtual void enable_grid(bool en=true)=0
virtual void set_line_width(unsigned int which, int width)=0
virtual void enable_axis_labels(bool en=true)=0
virtual void set_trigger_mode(trigger_mode mode, trigger_slope slope, float level, float delay, int channel, const std::string &tag_key="")=0
virtual std::string line_label(unsigned int which)=0
virtual QWidget * qwidget()=0
virtual int line_width(unsigned int which)=0
virtual void set_update_time(double t)=0
QApplication * d_qApplication
Definition: time_sink_f.h:155
virtual void set_line_color(unsigned int which, const std::string &color)=0
virtual std::string line_color(unsigned int which)=0
virtual int line_style(unsigned int which)=0
virtual void enable_tags(unsigned int which, bool en)=0
virtual void set_line_style(unsigned int which, int style)=0
virtual void exec_()=0
virtual void set_y_label(const std::string &label, const std::string &unit="")=0
virtual void enable_semilogx(bool en=true)=0
virtual void disable_legend()=0
virtual void set_y_axis(double min, double max)=0
virtual void enable_menu(bool en=true)=0
virtual void set_line_marker(unsigned int which, int marker)=0
virtual void enable_stem_plot(bool en=true)=0
virtual int line_marker(unsigned int which)=0
virtual void set_size(int width, int height)=0
virtual std::string title()=0
virtual double line_alpha(unsigned int which)=0
virtual void set_title(const std::string &title)=0
virtual void enable_semilogy(bool en=true)=0
virtual void enable_control_panel(bool en=true)=0
synchronous 1:1 input to output with history
Definition: sync_block.h:26
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:18
trigger_mode
Definition: trigger_mode.h:17
trigger_slope
Definition: trigger_mode.h:24
GNU Radio logging wrapper.
Definition: basic_block.h:29