GNU Radio Manual and C++ API Reference
3.7.5
The Free & Open Software Radio Ecosystem
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Groups
Pages
time_sink_c.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2011-2013 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_TIME_SINK_C_H
24
#define INCLUDED_QTGUI_TIME_SINK_C_H
25
26
#ifdef ENABLE_PYTHON
27
#include <Python.h>
28
#endif
29
30
#include <
gnuradio/qtgui/api.h
>
31
#include <
gnuradio/qtgui/trigger_mode.h
>
32
#include <
gnuradio/sync_block.h
>
33
#include <qapplication.h>
34
35
namespace
gr {
36
namespace
qtgui {
37
38
/*!
39
* \brief A graphical sink to display multiple signals in time.
40
* \ingroup instrumentation_blk
41
* \ingroup qtgui_blk
42
*
43
* \details
44
* This is a QT-based graphical sink the takes set of a complex
45
* streams and plots them in the time domain. For each signal, both
46
* the signal's I and Q parts are plotted, and they are all plotted
47
* with a different color, and the \a set_title and \a set_color
48
* functions can be used to change the lable and color for a given
49
* input number.
50
*/
51
class
QTGUI_API
time_sink_c
:
virtual
public
sync_block
52
{
53
public
:
54
// gr::qtgui::time_sink_c::sptr
55
typedef
boost::shared_ptr<time_sink_c>
sptr
;
56
57
/*!
58
* \brief Build complex time sink
59
*
60
* \param size number of points to plot at once
61
* \param samp_rate sample rate (used to set x-axis labels)
62
* \param name title for the plot
63
* \param nconnections number of signals connected to sink
64
* \param parent a QWidget parent object, if any
65
*/
66
static
sptr
make(
int
size,
double
samp_rate,
67
const
std::string &name,
68
int
nconnections=1,
69
QWidget *parent=NULL);
70
71
virtual
void
exec_() = 0;
72
virtual
QWidget* qwidget() = 0;
73
74
#ifdef ENABLE_PYTHON
75
virtual
PyObject* pyqwidget() = 0;
76
#else
77
virtual
void
* pyqwidget() = 0;
78
#endif
79
80
virtual
void
set_y_axis(
double
min
,
double
max) = 0;
81
virtual
void
set_y_label(
const
std::string &label,
82
const
std::string &unit=
""
) = 0;
83
virtual
void
set_update_time(
double
t) = 0;
84
virtual
void
set_title(
const
std::string &title) = 0;
85
virtual
void
set_line_label(
int
which,
const
std::string &label) = 0;
86
virtual
void
set_line_color(
int
which,
const
std::string &color) = 0;
87
virtual
void
set_line_width(
int
which,
int
width) = 0;
88
virtual
void
set_line_style(
int
which,
int
style) = 0;
89
virtual
void
set_line_marker(
int
which,
int
marker) = 0;
90
virtual
void
set_nsamps(
const
int
newsize) = 0;
91
virtual
void
set_samp_rate(
const
double
samp_rate) = 0;
92
virtual
void
set_line_alpha(
int
which,
double
alpha) = 0;
93
94
/*!
95
* Set up a trigger for the sink to know when to start
96
* plotting. Useful to isolate events and avoid noise.
97
*
98
* The trigger modes are Free, Auto, Normal, and Tag (see
99
* gr::qtgui::trigger_mode). The first three are like a normal
100
* oscope trigger function. Free means free running with no
101
* trigger, auto will trigger if the trigger event is seen, but
102
* will still plot otherwise, and normal will hold until the
103
* trigger event is observed. The Tag trigger mode allows us to
104
* trigger off a specific stream tag. The tag trigger is based
105
* only on the name of the tag, so when a tag of the given name
106
* is seen, the trigger is activated.
107
*
108
* In auto and normal mode, we look for the slope of the of the
109
* signal. Given a gr::qtgui::trigger_slope as either Positive
110
* or Negative, if the value between two samples moves in the
111
* given direction (x[1] > x[0] for Positive or x[1] < x[0] for
112
* Negative), then the trigger is activated.
113
*
114
* With the complex time sink, each input has two lines drawn
115
* for the real and imaginary parts of the signal. When
116
* selecting the \p channel value, channel 0 is the real signal
117
* and channel 1 is the imaginary signal. For more than 1 input
118
* stream, channel 2i is the real part of the ith input and
119
* channel (2i+1) is the imaginary part of the ith input
120
* channel.
121
*
122
* The \p delay value is specified in time based off the sample
123
* rate. If the sample rate of the block is set to 1, the delay
124
* is then also the sample number offset. This is the offset
125
* from the left-hand y-axis of the plot. It delays the signal
126
* to show the trigger event at the given delay along with some
127
* portion of the signal before the event. The delay must be
128
* within 0 - t_max where t_max is the maximum amount of time
129
* displayed on the time plot.
130
*
131
* \param mode The trigger_mode: free, auto, normal, or tag.
132
* \param slope The trigger_slope: positive or negative. Only
133
* used for auto and normal modes.
134
* \param level The magnitude of the trigger even for auto or normal modes.
135
* \param delay The delay (in units of time) for where the trigger happens.
136
* \param channel Which input channel to use for the trigger events.
137
* \param tag_key The name (as a string) of the tag to trigger off
138
* of if using the tag mode.
139
*/
140
virtual
void
set_trigger_mode(
trigger_mode
mode,
trigger_slope
slope,
141
float
level,
float
delay,
int
channel,
142
const
std::string &tag_key=
""
) = 0;
143
144
virtual
std::string title() = 0;
145
virtual
std::string line_label(
int
which) = 0;
146
virtual
std::string line_color(
int
which) = 0;
147
virtual
int
line_width(
int
which) = 0;
148
virtual
int
line_style(
int
which) = 0;
149
virtual
int
line_marker(
int
which) = 0;
150
virtual
double
line_alpha(
int
which) = 0;
151
152
virtual
void
set_size(
int
width,
int
height) = 0;
153
154
virtual
void
enable_menu(
bool
en=
true
) = 0;
155
virtual
void
enable_grid(
bool
en=
true
) = 0;
156
virtual
void
enable_autoscale(
bool
en=
true
) = 0;
157
virtual
void
enable_stem_plot(
bool
en=
true
) = 0;
158
virtual
void
enable_semilogx(
bool
en=
true
) = 0;
159
virtual
void
enable_semilogy(
bool
en=
true
) = 0;
160
virtual
void
enable_tags(
int
which,
bool
en) = 0;
161
162
virtual
int
nsamps()
const
= 0;
163
virtual
void
reset() = 0;
164
165
QApplication *
d_qApplication
;
166
};
167
168
}
/* namespace qtgui */
169
}
/* namespace gr */
170
171
#endif
/* INCLUDED_QTGUI_TIME_SINK_C_H */
gr-qtgui
include
gnuradio
qtgui
time_sink_c.h
Generated on Fri Oct 3 2014 00:33:51 for GNU Radio Manual and C++ API Reference by
1.8.1.2