GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
time_sink_c.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_C_H
24 #define INCLUDED_QTGUI_TIME_SINK_C_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 
35 namespace gr {
36  namespace 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 complex
45  * streams and plots them in the time domain. For each signal, both
46  * the signal's I and Q parts are plotted, and they are all plotted
47  * with a different color, and the \a set_title and \a set_color
48  * functions can be used to change the lable and color for a given
49  * input number.
50  *
51  * The sink supports plotting streaming complex data or
52  * messages. The message port is named "in". The two modes cannot
53  * be used simultaneously, and \p nconnections should be set to 0
54  * when using the message mode. GRC handles this issue by
55  * providing the "Complex Message" type that removes the streaming
56  * port(s).
57  *
58  * This sink can plot messages that contain either uniform vectors
59  * of complex 32 values (pmt::is_c32vector) or PDUs where the data
60  * is a uniform vector of complex 32 values.
61  */
62  class QTGUI_API time_sink_c : virtual public sync_block
63  {
64  public:
65  // gr::qtgui::time_sink_c::sptr
66  typedef boost::shared_ptr<time_sink_c> sptr;
67 
68  /*!
69  * \brief Build complex time sink
70  *
71  * \param size number of points to plot at once
72  * \param samp_rate sample rate (used to set x-axis labels)
73  * \param name title for the plot
74  * \param nconnections number of signals connected to sink
75  * \param parent a QWidget parent object, if any
76  */
77  static sptr make(int size, double samp_rate,
78  const std::string &name,
79  int nconnections=1,
80  QWidget *parent=NULL);
81 
82  virtual void exec_() = 0;
83  virtual QWidget* qwidget() = 0;
84 
85 #ifdef ENABLE_PYTHON
86  virtual PyObject* pyqwidget() = 0;
87 #else
88  virtual void* pyqwidget() = 0;
89 #endif
90 
91  virtual void set_y_axis(double min, double max) = 0;
92  virtual void set_y_label(const std::string &label,
93  const std::string &unit="") = 0;
94  virtual void set_update_time(double t) = 0;
95  virtual void set_title(const std::string &title) = 0;
96  virtual void set_line_label(int which, const std::string &label) = 0;
97  virtual void set_line_color(int which, const std::string &color) = 0;
98  virtual void set_line_width(int which, int width) = 0;
99  virtual void set_line_style(int which, int style) = 0;
100  virtual void set_line_marker(int which, int marker) = 0;
101  virtual void set_nsamps(const int newsize) = 0;
102  virtual void set_samp_rate(const double samp_rate) = 0;
103  virtual void set_line_alpha(int which, double alpha) = 0;
104 
105  /*!
106  * Set up a trigger for the sink to know when to start
107  * plotting. Useful to isolate events and avoid noise.
108  *
109  * The trigger modes are Free, Auto, Normal, and Tag (see
110  * gr::qtgui::trigger_mode). The first three are like a normal
111  * oscope trigger function. Free means free running with no
112  * trigger, auto will trigger if the trigger event is seen, but
113  * will still plot otherwise, and normal will hold until the
114  * trigger event is observed. The Tag trigger mode allows us to
115  * trigger off a specific stream tag. The tag trigger is based
116  * only on the name of the tag, so when a tag of the given name
117  * is seen, the trigger is activated.
118  *
119  * In auto and normal mode, we look for the slope of the of the
120  * signal. Given a gr::qtgui::trigger_slope as either Positive
121  * or Negative, if the value between two samples moves in the
122  * given direction (x[1] > x[0] for Positive or x[1] < x[0] for
123  * Negative), then the trigger is activated.
124  *
125  * With the complex time sink, each input has two lines drawn
126  * for the real and imaginary parts of the signal. When
127  * selecting the \p channel value, channel 0 is the real signal
128  * and channel 1 is the imaginary signal. For more than 1 input
129  * stream, channel 2i is the real part of the ith input and
130  * channel (2i+1) is the imaginary part of the ith input
131  * channel.
132  *
133  * The \p delay value is specified in time based off the sample
134  * rate. If the sample rate of the block is set to 1, the delay
135  * is then also the sample number offset. This is the offset
136  * from the left-hand y-axis of the plot. It delays the signal
137  * to show the trigger event at the given delay along with some
138  * portion of the signal before the event. The delay must be
139  * within 0 - t_max where t_max is the maximum amount of time
140  * displayed on the time plot.
141  *
142  * \param mode The trigger_mode: free, auto, normal, or tag.
143  * \param slope The trigger_slope: positive or negative. Only
144  * used for auto and normal modes.
145  * \param level The magnitude of the trigger even for auto or normal modes.
146  * \param delay The delay (in units of time) for where the trigger happens.
147  * \param channel Which input channel to use for the trigger events.
148  * \param tag_key The name (as a string) of the tag to trigger off
149  * of if using the tag mode.
150  */
151  virtual void set_trigger_mode(trigger_mode mode, trigger_slope slope,
152  float level, float delay, int channel,
153  const std::string &tag_key="") = 0;
154 
155  virtual std::string title() = 0;
156  virtual std::string line_label(int which) = 0;
157  virtual std::string line_color(int which) = 0;
158  virtual int line_width(int which) = 0;
159  virtual int line_style(int which) = 0;
160  virtual int line_marker(int which) = 0;
161  virtual double line_alpha(int which) = 0;
162 
163  virtual void set_size(int width, int height) = 0;
164 
165  virtual void enable_menu(bool en=true) = 0;
166  virtual void enable_grid(bool en=true) = 0;
167  virtual void enable_autoscale(bool en=true) = 0;
168  virtual void enable_stem_plot(bool en=true) = 0;
169  virtual void enable_semilogx(bool en=true) = 0;
170  virtual void enable_semilogy(bool en=true) = 0;
171  virtual void enable_control_panel(bool en=true) = 0;
172  virtual void enable_tags(int which, bool en) = 0;
173  virtual void disable_legend() = 0;
174 
175  virtual int nsamps() const = 0;
176  virtual void reset() = 0;
177 
178  QApplication *d_qApplication;
179  };
180 
181  } /* namespace qtgui */
182 } /* namespace gr */
183 
184 #endif /* INCLUDED_QTGUI_TIME_SINK_C_H */
float min(float a, float b)
QApplication * d_qApplication
Definition: time_sink_c.h:178
boost::shared_ptr< time_sink_c > sptr
Definition: time_sink_c.h:66
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:30
trigger_slope
Definition: gr-qtgui/include/gnuradio/qtgui/trigger_mode.h:36
trigger_mode
Definition: gr-qtgui/include/gnuradio/qtgui/trigger_mode.h:29
Include this header to use the message passing features.
Definition: logger.h:131
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
A graphical sink to display multiple signals in time.
Definition: time_sink_c.h:62