GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
gnuradio-3.7.14.0/gr-qtgui/include/gnuradio/qtgui/vector_sink_f.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2012,2014 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_VECTOR_SINK_F_H
24#define INCLUDED_QTGUI_VECTOR_SINK_F_H
25
26#ifdef ENABLE_PYTHON
27#include <Python.h>
28#endif
29
30#include <gnuradio/qtgui/api.h>
31#include <gnuradio/sync_block.h>
32#include <qapplication.h>
33
34namespace gr {
35namespace qtgui {
36
37/*!
38 * \brief A graphical sink to display multiple vector-based signals.
39 * \ingroup instrumentation_blk
40 * \ingroup qtgui_blk
41 *
42 * \details
43 * This is a QT-based graphical sink that plots vectors of data as-is.
44 * Each signal is plotted with a different color, and the set_title()
45 * and set_color() functions can be used to change the label and color
46 * for a given input number.
47 *
48 * To specify units for the x- and y-axes, use the set_x_axis_units()
49 * and set_y_axis_units() functions. This does not change the x- and
50 * y-labels, which are either specified during construction, or by
51 * calling the set_x_axis_label() and set_y_axis_label() methods.
52 */
53class QTGUI_API vector_sink_f : virtual public sync_block
54{
55public:
56 // gr::qtgui::vector_sink_f::sptr
57 typedef boost::shared_ptr<vector_sink_f> sptr;
58
59 /*!
60 * \brief Build a vector plotting sink.
61 *
62 * \param vlen Vector length at input. This cannot be changed during operations.
63 * \param x_start The x-Axis value of the first vector element
64 * \param x_step The step with which x-Axis values increment
65 * \param x_axis_label The X-Axis label
66 * \param y_axis_label The Y-Axis label
67 * \param name title for the plot
68 * \param nconnections number of signals connected to sink
69 * \param parent a QWidget parent object, if any
70 */
71 static sptr make(int vlen,
72 double x_start,
73 double x_step,
74 const std::string& x_axis_label,
75 const std::string& y_axis_label,
76 const std::string& name,
77 int nconnections = 1,
78 QWidget* parent = NULL);
79
80 virtual void exec_() = 0;
81 virtual QWidget* qwidget() = 0;
82
83#ifdef ENABLE_PYTHON
84 virtual PyObject* pyqwidget() = 0;
85#else
86 virtual void* pyqwidget() = 0;
87#endif
88
89 virtual int vlen() const = 0;
90 virtual void set_vec_average(const float avg) = 0;
91 virtual float vec_average() const = 0;
92
93 //! Update the values on the x-Axis.
94 //
95 // \param start The value for the first vector element.
96 // \param step Increments per x-Axis value
97 virtual void set_x_axis(const double start, const double step) = 0;
98 virtual void set_y_axis(double min, double max) = 0;
99 //! The ref level is a reference line
100 virtual void set_ref_level(double ref_level) = 0;
101
102 virtual void set_x_axis_label(const std::string& label) = 0;
103 virtual void set_y_axis_label(const std::string& label) = 0;
104
105 //! Change the units string on the x-Axis (e.g. 'm' if x-Axis label was 'Distance')
106 virtual void set_x_axis_units(const std::string& units) = 0;
107 //! Change the units string on the y-Axis (e.g. 'V' if x-Axis label was 'Amplitude')
108 virtual void set_y_axis_units(const std::string& units) = 0;
109
110 virtual void set_update_time(double t) = 0;
111 virtual void set_title(const std::string& title) = 0;
112 virtual void set_line_label(int which, const std::string& label) = 0;
113 virtual void set_line_color(int which, const std::string& color) = 0;
114 virtual void set_line_width(int which, int width) = 0;
115 virtual void set_line_style(int which, int style) = 0;
116 virtual void set_line_marker(int which, int marker) = 0;
117 virtual void set_line_alpha(int which, double alpha) = 0;
118
119 virtual std::string title() = 0;
120 virtual std::string line_label(int which) = 0;
121 virtual std::string line_color(int which) = 0;
122 virtual int line_width(int which) = 0;
123 virtual int line_style(int which) = 0;
124 virtual int line_marker(int which) = 0;
125 virtual double line_alpha(int which) = 0;
126
127 virtual void set_size(int width, int height) = 0;
128
129 virtual void enable_menu(bool en = true) = 0;
130 virtual void enable_grid(bool en = true) = 0;
131 virtual void enable_autoscale(bool en = true) = 0;
132 virtual void clear_max_hold() = 0;
133 virtual void clear_min_hold() = 0;
134 virtual void reset() = 0;
135
136 QApplication* d_qApplication;
137};
138
139} /* namespace qtgui */
140} /* namespace gr */
141
142#endif /* INCLUDED_QTGUI_VECTOR_SINK_F_H */
A graphical sink to display multiple vector-based signals.
Definition: gnuradio-3.7.14.0/gr-qtgui/include/gnuradio/qtgui/vector_sink_f.h:54
virtual float vec_average() const =0
virtual void set_line_width(int which, int width)=0
virtual void set_line_marker(int which, int marker)=0
QApplication * d_qApplication
Definition: gnuradio-3.7.14.0/gr-qtgui/include/gnuradio/qtgui/vector_sink_f.h:136
virtual std::string line_color(int which)=0
virtual void set_x_axis(const double start, const double step)=0
Update the values on the x-Axis.
virtual void set_y_axis_label(const std::string &label)=0
virtual void set_line_label(int which, const std::string &label)=0
virtual void set_x_axis_units(const std::string &units)=0
Change the units string on the x-Axis (e.g. 'm' if x-Axis label was 'Distance')
boost::shared_ptr< vector_sink_f > sptr
Definition: gnuradio-3.7.14.0/gr-qtgui/include/gnuradio/qtgui/vector_sink_f.h:57
virtual double line_alpha(int which)=0
virtual void set_update_time(double t)=0
virtual void set_title(const std::string &title)=0
virtual std::string title()=0
virtual void set_line_color(int which, const std::string &color)=0
virtual void * pyqwidget()=0
virtual void clear_max_hold()=0
virtual void set_x_axis_label(const std::string &label)=0
virtual void enable_autoscale(bool en=true)=0
virtual void set_line_style(int which, int style)=0
virtual void set_vec_average(const float avg)=0
virtual void set_line_alpha(int which, double alpha)=0
virtual void set_y_axis(double min, double max)=0
virtual void enable_grid(bool en=true)=0
virtual void enable_menu(bool en=true)=0
virtual int vlen() const =0
virtual int line_width(int which)=0
virtual void set_size(int width, int height)=0
virtual QWidget * qwidget()=0
virtual void set_y_axis_units(const std::string &units)=0
Change the units string on the y-Axis (e.g. 'V' if x-Axis label was 'Amplitude')
virtual void reset()=0
virtual int line_marker(int which)=0
virtual std::string line_label(int which)=0
virtual void set_ref_level(double ref_level)=0
The ref level is a reference line.
virtual int line_style(int which)=0
static sptr make(int vlen, double x_start, double x_step, const std::string &x_axis_label, const std::string &y_axis_label, const std::string &name, int nconnections=1, QWidget *parent=NULL)
Build a vector plotting sink.
virtual void clear_min_hold()=0
virtual void exec_()=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
float min(float a, float b)
Include this header to use the message passing features.
Definition: basic_block.h:45