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

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

Loading...
Searching...
No Matches
burst_tagger.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2010,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_GR_BURST_TAGGER_H
12#define INCLUDED_GR_BURST_TAGGER_H
13
14#include <gnuradio/blocks/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18namespace blocks {
19
20/*!
21 * \brief Sets a burst on/off tag based on the value of the trigger input.
22 * \ingroup peak_detectors_blk
23 * \ingroup stream_tag_tools_blk
24 *
25 * \details
26 * This block takes two inputs, a signal stream on the input
27 * stream 0 and a trigger stream of shorts on input stream 1. If
28 * the trigger stream goes above 0, a tag with the key "burst"
29 * will be transmitted as a pmt::PMT_T. When the trigger signal
30 * falls below 0, the "burst" tag will be transmitted as
31 * pmt::PMT_F.
32 *
33 * The signal on stream 0 is retransmitted to output stream 0.
34 */
35 class BLOCKS_API burst_tagger : virtual public sync_block
36{
37public:
38 // gr::blocks::burst_tagger::sptr
39 typedef std::shared_ptr<burst_tagger> sptr;
40
41 /*!
42 * Build a burst tagger gnuradio/blocks.
43 *
44 * \param itemsize itemsize of the signal stream on input 0.
45 */
46 static sptr make(size_t itemsize);
47
48 /*!
49 * For the true burst tag, change the key name to \p key and a
50 * new value of \p value.
51 */
52 virtual void set_true_tag(const std::string& key, bool value) = 0;
53
54 /*!
55 * For the false burst tag, change the key name to \p key and a
56 * new value of \p value.
57 */
58 virtual void set_false_tag(const std::string& key, bool value) = 0;
59};
60
61} /* namespace blocks */
62} /* namespace gr */
63
64#endif /* INCLUDED_GR_BURST_TAGGER_H */
gr::blocks::burst_tagger
Sets a burst on/off tag based on the value of the trigger input.
Definition burst_tagger.h:36
gr::blocks::burst_tagger::sptr
std::shared_ptr< burst_tagger > sptr
Definition burst_tagger.h:39
gr::blocks::burst_tagger::make
static sptr make(size_t itemsize)
gr::blocks::burst_tagger::set_true_tag
virtual void set_true_tag(const std::string &key, bool value)=0
gr::blocks::burst_tagger::set_false_tag
virtual void set_false_tag(const std::string &key, bool value)=0
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
sync_block.h