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_f.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_F_H
24
#define INCLUDED_QTGUI_TIME_SINK_F_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 float streams
45
* and plots them in the time domain. Each signal is plotted with a
46
* different color, and the \a set_title and \a set_color functions
47
* can be used to change the lable and color for a given input number.
48
*/
49
class
QTGUI_API
time_sink_f
:
virtual
public
sync_block
50
{
51
public
:
52
// gr::qtgui::time_sink_f::sptr
53
typedef
boost::shared_ptr<time_sink_f>
sptr
;
54
55
/*!
56
* \brief Build floating point time sink
57
*
58
* \param size number of points to plot at once
59
* \param samp_rate sample rate (used to set x-axis labels)
60
* \param name title for the plot
61
* \param nconnections number of signals connected to sink
62
* \param parent a QWidget parent object, if any
63
*/
64
static
sptr
make(
int
size,
double
samp_rate,
65
const
std::string &name,
66
int
nconnections=1,
67
QWidget *parent=NULL);
68
69
virtual
void
exec_() = 0;
70
virtual
QWidget* qwidget() = 0;
71
72
#ifdef ENABLE_PYTHON
73
virtual
PyObject* pyqwidget() = 0;
74
#else
75
virtual
void
* pyqwidget() = 0;
76
#endif
77
78
virtual
void
set_y_axis(
double
min
,
double
max) = 0;
79
virtual
void
set_y_label(
const
std::string &label,
80
const
std::string &unit=
""
) = 0;
81
virtual
void
set_update_time(
double
t) = 0;
82
virtual
void
set_title(
const
std::string &title) = 0;
83
virtual
void
set_line_label(
int
which,
const
std::string &line) = 0;
84
virtual
void
set_line_color(
int
which,
const
std::string &color) = 0;
85
virtual
void
set_line_width(
int
which,
int
width) = 0;
86
virtual
void
set_line_style(
int
which,
int
style) = 0;
87
virtual
void
set_line_marker(
int
which,
int
marker) = 0;
88
virtual
void
set_nsamps(
const
int
newsize) = 0;
89
virtual
void
set_samp_rate(
const
double
samp_rate) = 0;
90
virtual
void
set_line_alpha(
int
which,
double
alpha) = 0;
91
92
/*!
93
* Set up a trigger for the sink to know when to start
94
* plotting. Useful to isolate events and avoid noise.
95
*
96
* The trigger modes are Free, Auto, Normal, and Tag (see
97
* gr::qtgui::trigger_mode). The first three are like a normal
98
* oscope trigger function. Free means free running with no
99
* trigger, auto will trigger if the trigger event is seen, but
100
* will still plot otherwise, and normal will hold until the
101
* trigger event is observed. The Tag trigger mode allows us to
102
* trigger off a specific stream tag. The tag trigger is based
103
* only on the name of the tag, so when a tag of the given name
104
* is seen, the trigger is activated.
105
*
106
* In auto and normal mode, we look for the slope of the of the
107
* signal. Given a gr::qtgui::trigger_slope as either Positive
108
* or Negative, if the value between two samples moves in the
109
* given direction (x[1] > x[0] for Positive or x[1] < x[0] for
110
* Negative), then the trigger is activated.
111
*
112
* The \p delay value is specified in time based off the sample
113
* rate. If the sample rate of the block is set to 1, the delay
114
* is then also the sample number offset. This is the offset
115
* from the left-hand y-axis of the plot. It delays the signal
116
* to show the trigger event at the given delay along with some
117
* portion of the signal before the event. The delay must be
118
* within 0 - t_max where t_max is the maximum amount of time
119
* displayed on the time plot.
120
*
121
* \param mode The trigger_mode: free, auto, normal, or tag.
122
* \param slope The trigger_slope: positive or negative. Only
123
* used for auto and normal modes.
124
* \param level The magnitude of the trigger even for auto or normal modes.
125
* \param delay The delay (in units of time) for where the trigger happens.
126
* \param channel Which input channel to use for the trigger events.
127
* \param tag_key The name (as a string) of the tag to trigger off
128
* of if using the tag mode.
129
*/
130
virtual
void
set_trigger_mode(
trigger_mode
mode,
trigger_slope
slope,
131
float
level,
float
delay,
int
channel,
132
const
std::string &tag_key=
""
) = 0;
133
134
virtual
std::string title() = 0;
135
virtual
std::string line_label(
int
which) = 0;
136
virtual
std::string line_color(
int
which) = 0;
137
virtual
int
line_width(
int
which) = 0;
138
virtual
int
line_style(
int
which) = 0;
139
virtual
int
line_marker(
int
which) = 0;
140
virtual
double
line_alpha(
int
which) = 0;
141
142
virtual
void
set_size(
int
width,
int
height) = 0;
143
144
virtual
void
enable_menu(
bool
en=
true
) = 0;
145
virtual
void
enable_grid(
bool
en=
true
) = 0;
146
virtual
void
enable_autoscale(
bool
en=
true
) = 0;
147
virtual
void
enable_stem_plot(
bool
en=
true
) = 0;
148
virtual
void
enable_semilogx(
bool
en=
true
) = 0;
149
virtual
void
enable_semilogy(
bool
en=
true
) = 0;
150
virtual
void
enable_tags(
int
which,
bool
en) = 0;
151
152
virtual
int
nsamps()
const
= 0;
153
virtual
void
reset() = 0;
154
155
QApplication *
d_qApplication
;
156
};
157
158
}
/* namespace qtgui */
159
}
/* namespace gr */
160
161
#endif
/* INCLUDED_QTGUI_TIME_SINK_F_H */
gr-qtgui
include
gnuradio
qtgui
time_sink_f.h
Generated on Fri Oct 3 2014 00:33:51 for GNU Radio Manual and C++ API Reference by
1.8.1.2