diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 18:00:06 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 18:00:06 -0400 |
| commit | b0acaef8de114d51920d8c7945481c5ca7b7d104 (patch) | |
| tree | c7931068b98ba396c8be685cb278ffb2c3e099c7 /gr-qtgui/include | |
| parent | e2b943d6ea4e92d5364a5a31b2feb34d54990b08 (diff) | |
docs and qtgui: adding Doxygen documentation for each class. Also changed the default behavior for the qtgui_sink_f to turn the constellation plot off by default (doesn't make sense with out the Q part, too).
Diffstat (limited to 'gr-qtgui/include')
| -rw-r--r-- | gr-qtgui/include/qtgui_sink_c.h | 11 | ||||
| -rw-r--r-- | gr-qtgui/include/qtgui_sink_f.h | 13 | ||||
| -rw-r--r-- | gr-qtgui/include/qtgui_time_sink_c.h | 11 | ||||
| -rw-r--r-- | gr-qtgui/include/qtgui_time_sink_f.h | 9 |
4 files changed, 43 insertions, 1 deletions
diff --git a/gr-qtgui/include/qtgui_sink_c.h b/gr-qtgui/include/qtgui_sink_c.h index b0946885cc..b04706b14e 100644 --- a/gr-qtgui/include/qtgui_sink_c.h +++ b/gr-qtgui/include/qtgui_sink_c.h @@ -41,6 +41,17 @@ GR_QTGUI_API qtgui_sink_c_sptr qtgui_make_sink_c (int fftsize, int wintype, bool plottime=true, bool plotconst=true, QWidget *parent=NULL); +/*! + * \brief A graphical sink to display freq, spec, time, and const plots. + * \ingroup qtgui_blk + * + * This is a QT-based graphical sink the takes a complex stream and + * plots it. The default action is to plot the signal as a PSD (FFT), + * spectrogram (waterfall), time domain I&Q, and constellation (I + * vs. Q) plots. The plots may be turned off by setting the + * appropriate boolean value in the constructor to False. + */ + class GR_QTGUI_API qtgui_sink_c : public gr_block { private: diff --git a/gr-qtgui/include/qtgui_sink_f.h b/gr-qtgui/include/qtgui_sink_f.h index 30db05eea0..bc14147c25 100644 --- a/gr-qtgui/include/qtgui_sink_f.h +++ b/gr-qtgui/include/qtgui_sink_f.h @@ -39,9 +39,20 @@ GR_QTGUI_API qtgui_sink_f_sptr qtgui_make_sink_f (int fftsize, int wintype, double fc=0, double bw=1.0, const std::string &name="Spectrum Display", bool plotfreq=true, bool plotwaterfall=true, - bool plottime=true, bool plotconst=true, + bool plottime=true, bool plotconst=false, QWidget *parent=NULL); +/*! + * \brief A graphical sink to display freq, spec, and time. + * \ingroup qtgui_blk + * + * This is a QT-based graphical sink the takes a float stream and + * plots it. The default action is to plot the signal as a PSD (FFT), + * spectrogram (waterfall), and time domain plots. The plots may be + * turned off by setting the appropriate boolean value in the + * constructor to False. + */ + class GR_QTGUI_API qtgui_sink_f : public gr_block { private: diff --git a/gr-qtgui/include/qtgui_time_sink_c.h b/gr-qtgui/include/qtgui_time_sink_c.h index 51d5ad1833..ec7cc490bf 100644 --- a/gr-qtgui/include/qtgui_time_sink_c.h +++ b/gr-qtgui/include/qtgui_time_sink_c.h @@ -39,6 +39,17 @@ GR_QTGUI_API qtgui_time_sink_c_sptr qtgui_make_time_sink_c(int size, double bw, int nconnectons=1, QWidget *parent=NULL); +/*! + * \brief A graphical sink to display multiple signals in time. + * \ingroup qtgui_blk + * + * This is a QT-based graphical sink the takes set of a complex + * streams and plots them in the time domain. For each signal, both + * the signal's I and Q parts are plotted, and they are all plotted + * with a different color, and the \a set_title and \a set_color + * functions can be used to change the lable and color for a given + * input number. + */ class GR_QTGUI_API qtgui_time_sink_c : public gr_sync_block { private: diff --git a/gr-qtgui/include/qtgui_time_sink_f.h b/gr-qtgui/include/qtgui_time_sink_f.h index a69d328772..ff17f8a1b2 100644 --- a/gr-qtgui/include/qtgui_time_sink_f.h +++ b/gr-qtgui/include/qtgui_time_sink_f.h @@ -39,6 +39,15 @@ GR_QTGUI_API qtgui_time_sink_f_sptr qtgui_make_time_sink_f(int size, double bw, int nconnectons=1, QWidget *parent=NULL); +/*! + * \brief A graphical sink to display multiple signals in time. + * \ingroup qtgui_blk + * + * This is a QT-based graphical sink the takes set of a float streams + * and plots them in the time domain. Each signal is plotted with a + * different color, and the \a set_title and \a set_color functions + * can be used to change the lable and color for a given input number. + */ class GR_QTGUI_API qtgui_time_sink_f : public gr_sync_block { private: |