summaryrefslogtreecommitdiff
path: root/gr-qtgui
diff options
context:
space:
mode:
Diffstat (limited to 'gr-qtgui')
-rw-r--r--gr-qtgui/include/qtgui_sink_c.h11
-rw-r--r--gr-qtgui/include/qtgui_sink_f.h13
-rw-r--r--gr-qtgui/include/qtgui_time_sink_c.h11
-rw-r--r--gr-qtgui/include/qtgui_time_sink_f.h9
-rw-r--r--gr-qtgui/swig/qtgui_sink_f.i2
5 files changed, 44 insertions, 2 deletions
diff --git a/gr-qtgui/include/qtgui_sink_c.h b/gr-qtgui/include/qtgui_sink_c.h
index b0946885c..b04706b14 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 30db05eea..bc14147c2 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 51d5ad183..ec7cc490b 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 a69d32877..ff17f8a1b 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:
diff --git a/gr-qtgui/swig/qtgui_sink_f.i b/gr-qtgui/swig/qtgui_sink_f.i
index c5eb656b9..a34420461 100644
--- a/gr-qtgui/swig/qtgui_sink_f.i
+++ b/gr-qtgui/swig/qtgui_sink_f.i
@@ -32,7 +32,7 @@ qtgui_sink_f_sptr qtgui_make_sink_f (int fftsize, int wintype,
double fc=0, double bw=0.0,
const std::string &name="Display",
bool plotfreq=true, bool plotwaterfall=true,
- bool plottime=true, bool plotconst=true,
+ bool plottime=true, bool plotconst=false,
QWidget *parent=NULL);
class qtgui_sink_f : public gr_block