GNU Radio Radar Toolbox
qtgui_time_plot.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2014 Communications Engineering Lab, KIT.
4  *
5  * This is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3, or (at your option)
8  * any later version.
9  *
10  * This software is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this software; see the file COPYING. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street,
18  * Boston, MA 02110-1301, USA.
19  */
20 
21 
22 #ifndef INCLUDED_RADAR_QTGUI_TIME_PLOT_H
23 #define INCLUDED_RADAR_QTGUI_TIME_PLOT_H
24 
25 #include <gnuradio/block.h>
26 #include <radar/api.h>
27 
28 namespace gr {
29 namespace radar {
30 
31 /*!
32  * \brief This block displays a plot of a value with a given interval in milliseconds.
33  * label_y represents the identifier (symbol) of the data. The y axis is scaled with
34  * axis_y. range_time gives the shown range of the x axis in seconds. label is an
35  * additional label for the title.
36  *
37  * \param interval Update interval in milliseconds
38  * \param label_y Lable for y axis and identifier (symbol) for data
39  * \param axis_y Display range y axis
40  * \param range_time Display range for x axis in seconds
41  * \param label Additional label for the title
42  *
43  * \ingroup radar
44  *
45  */
46 class RADAR_API qtgui_time_plot : virtual public gr::block
47 {
48 public:
49  typedef boost::shared_ptr<qtgui_time_plot> sptr;
50 
51  /*!
52  * \brief Return a shared_ptr to a new instance of radar::qtgui_time_plot.
53  *
54  * To avoid accidental use of raw pointers, radar::qtgui_time_plot's
55  * constructor is in a private implementation
56  * class. radar::qtgui_time_plot::make is the public interface for
57  * creating new instances.
58  */
59  static sptr make(int interval,
60  std::string label_y,
61  std::vector<float> axis_y,
62  float range_time,
63  std::string label = "");
64 };
65 
66 } // namespace radar
67 } // namespace gr
68 
69 #endif /* INCLUDED_RADAR_QTGUI_TIME_PLOT_H */
gr::radar::qtgui_time_plot
This block displays a plot of a value with a given interval in milliseconds. label_y represents the i...
Definition: qtgui_time_plot.h:47
RADAR_API
#define RADAR_API
Definition: api.h:31
gr::radar::qtgui_time_plot::make
static sptr make(int interval, std::string label_y, std::vector< float > axis_y, float range_time, std::string label="")
Return a shared_ptr to a new instance of radar::qtgui_time_plot.
gr::radar::qtgui_time_plot::sptr
boost::shared_ptr< qtgui_time_plot > sptr
Definition: qtgui_time_plot.h:49
gr
Definition: crop_matrix_vcvc.h:28
api.h