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