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

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

Loading...
Searching...
No Matches
ctrlport_probe_c.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_C_H
12#define INCLUDED_CTRLPORT_PROBE_C_H
13
14#include <gnuradio/blocks/api.h>
15#include <gnuradio/rpcregisterhelpers.h>
16#include <gnuradio/sync_block.h>
17
18namespace gr {
19namespace blocks {
20
21/*!
22 * \brief A ControlPort probe to export vectors of signals.
23 * \ingroup measurement_tools_blk
24 * \ingroup controlport_blk
25 *
26 * \details
27 * This block acts as a sink in the flowgraph but also exports
28 * vectors of complex samples over ControlPort. This block simply
29 * sends the current vector held in the work function when the
30 * queried by a ControlPort client.
31 */
32 class BLOCKS_API ctrlport_probe_c : virtual public sync_block
33{
34public:
35 // gr::blocks::ctrlport_probe_c::sptr
36 typedef std::shared_ptr<ctrlport_probe_c> sptr;
37
38 /*!
39 * \brief Make a ControlPort probe block.
40 * \param id A string ID to name the probe over ControlPort.
41 * \param desc A string describing the probe.
42 */
43 static sptr make(const std::string& id, const std::string& desc);
44
45 virtual std::vector<gr_complex> get() = 0;
46};
47
48} /* namespace blocks */
49} /* namespace gr */
50
51#endif /* INCLUDED_CTRLPORT_GR_CTRLPORT_PROBE_C_H */
gr::blocks::ctrlport_probe_c
A ControlPort probe to export vectors of signals.
Definition ctrlport_probe_c.h:33
gr::blocks::ctrlport_probe_c::make
static sptr make(const std::string &id, const std::string &desc)
Make a ControlPort probe block.
gr::blocks::ctrlport_probe_c::get
virtual std::vector< gr_complex > get()=0
gr::blocks::ctrlport_probe_c::sptr
std::shared_ptr< ctrlport_probe_c > sptr
Definition ctrlport_probe_c.h:36
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
BLOCKS_API
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
gr::blocks
Definition abs_blk.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
rpcregisterhelpers.h
sync_block.h