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
const_sink_c.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012,2014-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_CONST_SINK_C_H
24 #define INCLUDED_QTGUI_CONST_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 #include <gnuradio/filter/firdes.h>
35 
36 namespace gr {
37  namespace qtgui {
38 
39  /*!
40  * \brief A graphical sink to display the IQ constellation of multiple signals.
41  * \ingroup instrumentation_blk
42  * \ingroup qtgui_blk
43  *
44  * \details
45  * This is a QT-based graphical sink the takes set of a complex
46  * streams and plots them on an IQ constellation plot.
47  *
48  * The sink supports plotting streaming complex data or
49  * messages. The message port is named "in". The two modes cannot
50  * be used simultaneously, and \p nconnections should be set to 0
51  * when using the message mode. GRC handles this issue by
52  * providing the "Complex Message" type that removes the streaming
53  * port(s).
54  *
55  * This sink can plot messages that contain either uniform vectors
56  * of complex 32 values (pmt::is_c32vector) or PDUs where the data
57  * is a uniform vector of complex 32 values.
58  */
59  class QTGUI_API const_sink_c : virtual public sync_block
60  {
61  public:
62  // gr::qtgui::const_sink_c::sptr
63  typedef boost::shared_ptr<const_sink_c> sptr;
64 
65  /*!
66  * \brief Build a constellation plot sink.
67  *
68  * \param size number of points to plot at once
69  * \param name title for the plot
70  * \param nconnections number of signals connected to sink
71  * \param parent a QWidget parent object, if any
72  */
73  static sptr make(int size,
74  const std::string &name,
75  int nconnections=1,
76  QWidget *parent=NULL);
77 
78  virtual void exec_() = 0;
79  virtual QWidget* qwidget() = 0;
80 
81 #ifdef ENABLE_PYTHON
82  virtual PyObject* pyqwidget() = 0;
83 #else
84  virtual void* pyqwidget() = 0;
85 #endif
86 
87  virtual void set_y_axis(double min, double max) = 0;
88  virtual void set_x_axis(double min, double max) = 0;
89 
90  virtual void set_update_time(double t) = 0;
91  virtual void set_title(const std::string &title) = 0;
92  virtual void set_line_label(int which, const std::string &label) = 0;
93  virtual void set_line_color(int which, const std::string &color) = 0;
94  virtual void set_line_width(int which, int width) = 0;
95  virtual void set_line_style(int which, int style) = 0;
96  virtual void set_line_marker(int which, int marker) = 0;
97  virtual void set_nsamps(const int newsize) = 0;
98  virtual void set_line_alpha(int which, double alpha) = 0;
99 
100  /*!
101  * Set up a trigger for the sink to know when to start
102  * plotting. Useful to isolate events and avoid noise.
103  *
104  * The trigger modes are Free, Auto, Normal, and Tag (see
105  * gr::qtgui::trigger_mode). The first three are like a normal
106  * oscope trigger function. Free means free running with no
107  * trigger, auto will trigger if the trigger event is seen, but
108  * will still plot otherwise, and normal will hold until the
109  * trigger event is observed. The Tag trigger mode allows us to
110  * trigger off a specific stream tag. The tag trigger is based
111  * only on the name of the tag, so when a tag of the given name
112  * is seen, the trigger is activated.
113  *
114  * In auto and normal mode, we look for the slope of the
115  * magnitude of the signal. As a constellation sink, this only
116  * takes in complex numbers to plot. Given a
117  * gr::qtgui::trigger_slope as either Positive or Negative, if
118  * the magnitude between two samples moves in the given
119  * direction (x[1] > x[0] for Positive or x[1] < x[0] for
120  * Negative), then the trigger is activated.
121  *
122  * \param mode The trigger_mode: free, auto, normal, or tag.
123  * \param slope The trigger_slope: positive or negative. Only
124  * used for auto and normal modes.
125  * \param level The magnitude of the trigger even for auto or normal modes.
126  * \param channel Which input channel to use for the trigger events.
127  * \param tag_key The name (as a string) of the tag to trigger off
128  * of if using the tag mode.
129  */
130  virtual void set_trigger_mode(trigger_mode mode, trigger_slope slope,
131  float level, int channel,
132  const std::string &tag_key="") = 0;
133 
134  virtual std::string title() = 0;
135  virtual std::string line_label(int which) = 0;
136  virtual std::string line_color(int which) = 0;
137  virtual int line_width(int which) = 0;
138  virtual int line_style(int which) = 0;
139  virtual int line_marker(int which) = 0;
140  virtual double line_alpha(int which) = 0;
141 
142  virtual void set_size(int width, int height) = 0;
143 
144  virtual void enable_menu(bool en=true) = 0;
145  virtual void enable_autoscale(bool en) = 0;
146  virtual void enable_grid(bool en) = 0;
147  virtual void disable_legend() = 0;
148  virtual int nsamps() const = 0;
149  virtual void reset() = 0;
150 
151  QApplication *d_qApplication;
152  };
153 
154  } /* namespace qtgui */
155 } /* namespace gr */
156 
157 #endif /* INCLUDED_QTGUI_CONST_SINK_C_H */
float min(float a, float b)
boost::shared_ptr< const_sink_c > sptr
Definition: const_sink_c.h:63
#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 the IQ constellation of multiple signals.
Definition: const_sink_c.h:59
QApplication * d_qApplication
Definition: const_sink_c.h:151