GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ctrlport_probe2_s.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 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_PROBE2_S_H
24 #define INCLUDED_CTRLPORT_PROBE2_S_H
25 
26 #include <gnuradio/blocks/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace blocks {
31 
32  /*!
33  * \brief A ControlPort probe to export vectors of signals.
34  * \ingroup measurement_tools_blk
35  * \ingroup controlport_blk
36  *
37  * \details
38  * This block acts as a sink in the flowgraph but also exports
39  * vectors of complex samples over ControlPort. This block holds
40  * the latest \p len number of complex samples so that every query
41  * by a ControlPort client will get the same length vector.
42  */
43  class BLOCKS_API ctrlport_probe2_s : virtual public sync_block
44  {
45  public:
46  // gr::blocks::ctrlport_probe2_s::sptr
47  typedef boost::shared_ptr<ctrlport_probe2_s> sptr;
48 
49  /*!
50  * \brief Make a ControlPort probe block.
51  * \param id A string ID to name the probe over ControlPort.
52  * \param desc A string describing the probe.
53  * \param len Number of samples to transmit.
54  * \param disp_mask Mask to set default display params.
55  */
56  static sptr make(const std::string &id, const std::string &desc,
57  int len, unsigned int disp_mask);
58 
59  virtual std::vector<short> get() = 0;
60 
61  virtual void set_length(int len) = 0;
62  virtual int length() const = 0;
63  };
64 
65  } /* namespace blocks */
66 } /* namespace gr */
67 
68 #endif /* INCLUDED_CTRLPORT_PROBE2_S_H */
69 
Include this header to use the message passing features.
Definition: logger.h:131
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
PMT_API size_t length(const pmt_t &v)
Return the number of elements in v.
boost::shared_ptr< ctrlport_probe2_s > sptr
Definition: ctrlport_probe2_s.h:47
A ControlPort probe to export vectors of signals.
Definition: ctrlport_probe2_s.h:43