GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
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 * 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_CTRLPORT_PROBE_C_H
24#define INCLUDED_CTRLPORT_PROBE_C_H
25
26#include <gnuradio/blocks/api.h>
28#include <gnuradio/sync_block.h>
29#include <boost/thread/shared_mutex.hpp>
30
31namespace gr {
32namespace blocks {
33
34/*!
35 * \brief A ControlPort probe to export vectors of signals.
36 * \ingroup measurement_tools_blk
37 * \ingroup controlport_blk
38 *
39 * \details
40 * This block acts as a sink in the flowgraph but also exports
41 * vectors of complex samples over ControlPort. This block simply
42 * sends the current vector held in the work function when the
43 * queried by a ControlPort client.
44 */
46{
47public:
48 // gr::blocks::ctrlport_probe_c::sptr
49 typedef boost::shared_ptr<ctrlport_probe_c> sptr;
50
51 /*!
52 * \brief Make a ControlPort probe block.
53 * \param id A string ID to name the probe over ControlPort.
54 * \param desc A string describing the probe.
55 */
56 static sptr make(const std::string& id, const std::string& desc);
57
58 virtual std::vector<gr_complex> get() = 0;
59};
60
61} /* namespace blocks */
62} /* namespace gr */
63
64#endif /* INCLUDED_CTRLPORT_GR_CTRLPORT_PROBE_C_H */
A ControlPort probe to export vectors of signals.
Definition: ctrlport_probe_c.h:46
boost::shared_ptr< ctrlport_probe_c > sptr
Definition: ctrlport_probe_c.h:49
static sptr make(const std::string &id, const std::string &desc)
Make a ControlPort probe block.
virtual std::vector< gr_complex > get()=0
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45