summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio/blocks/ctrlport_probe2_s.h
blob: 1c86f0e63101a20f1b2ebb55124b2d5868b20d62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/* -*- c++ -*- */
/*
 * Copyright 2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#ifndef INCLUDED_CTRLPORT_PROBE2_S_H
#define INCLUDED_CTRLPORT_PROBE2_S_H

#include <gnuradio/blocks/api.h>
#include <gnuradio/sync_block.h>

namespace gr {
namespace blocks {

/*!
 * \brief A ControlPort probe to export vectors of signals.
 * \ingroup measurement_tools_blk
 * \ingroup controlport_blk
 *
 * \details
 * This block acts as a sink in the flowgraph but also exports
 * vectors of complex samples over ControlPort. This block holds
 * the latest \p len number of complex samples so that every query
 * by a ControlPort client will get the same length vector.
 */
class BLOCKS_API ctrlport_probe2_s : virtual public sync_block
{
public:
    // gr::blocks::ctrlport_probe2_s::sptr
    typedef std::shared_ptr<ctrlport_probe2_s> sptr;

    /*!
     * \brief Make a ControlPort probe block.
     * \param id A string ID to name the probe over ControlPort.
     * \param desc A string describing the probe.
     * \param len Number of samples to transmit.
     * \param disp_mask Mask to set default display params.
     */
    static sptr
    make(const std::string& id, const std::string& desc, int len, unsigned int disp_mask);

    virtual std::vector<short> get() = 0;

    virtual void set_length(int len) = 0;
    virtual int length() const = 0;
};

} /* namespace blocks */
} /* namespace gr */

#endif /* INCLUDED_CTRLPORT_PROBE2_S_H */