GNU Radio C++ API Reference: ctrlport_probe_psd.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
ctrlport_probe_psd.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2012-2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_CTRLPORT_PROBE_PSD_H
12#define INCLUDED_CTRLPORT_PROBE_PSD_H
13
14#include <gnuradio/fft/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18 namespace fft {
19
20/*!
21 * \brief A ControlPort probe to export vectors of signals.
22 * \ingroup measurement_tools_blk
23 * \ingroup controlport_blk
24 *
25 * \details
26 * This block acts as a sink in the flowgraph but also exports
27 * vectors of complex samples over ControlPort. This block holds
28 * the latest \p len number of complex samples so that every query
29 * by a ControlPort client will get the same length vector.
30 */
31 class FFT_API ctrlport_probe_psd : virtual public gr::sync_block
32{
33public:
34 typedef std::shared_ptr<ctrlport_probe_psd> sptr;
35
36 /*!
37 * \brief Make a ControlPort probe block.
38 * \param id A string ID to name the probe over ControlPort.
39 * \param desc A string describing the probe.
40 * \param len Number of samples to transmit.
41 */
42 static sptr make(const std::string& id, const std::string& desc, int len);
43
44 virtual std::vector<gr_complex> get() = 0;
45
46 virtual void set_length(int len) = 0;
47 virtual int length() const = 0;
48};
49
50} /* namespace fft */
51} /* namespace gr */
52
53#endif /* INCLUDED_CTRLPORT_PROBE_PSD_H */
gr::fft::ctrlport_probe_psd
A ControlPort probe to export vectors of signals.
Definition ctrlport_probe_psd.h:32
gr::fft::ctrlport_probe_psd::get
virtual std::vector< gr_complex > get()=0
gr::fft::ctrlport_probe_psd::length
virtual int length() const =0
gr::fft::ctrlport_probe_psd::make
static sptr make(const std::string &id, const std::string &desc, int len)
Make a ControlPort probe block.
gr::fft::ctrlport_probe_psd::set_length
virtual void set_length(int len)=0
gr::fft::ctrlport_probe_psd::sptr
std::shared_ptr< ctrlport_probe_psd > sptr
Definition ctrlport_probe_psd.h:34
gr::fft::fft
Definition fft.h:70
gr::sync_block
synchronous 1:1 input to output with history
Definition sync_block.h:26
api.h
FFT_API
#define FFT_API
Definition gr-fft/include/gnuradio/fft/api.h:18
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h