GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
tag_gate.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_BLOCKS_TAG_GATE_H
24#define INCLUDED_BLOCKS_TAG_GATE_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief Control tag propagation.
34 * \ingroup blocks
35 *
36 * Use this block to stop tags from propagating.
37 */
38class BLOCKS_API tag_gate : virtual public gr::sync_block
39{
40public:
41 typedef boost::shared_ptr<tag_gate> sptr;
42
43 virtual void set_propagation(bool propagate_tags) = 0;
44
45 /*!
46 * \param item_size Item size
47 * \param propagate_tags Set this to true to allow tags to pass through this block.
48 */
49 static sptr make(size_t item_size, bool propagate_tags = false);
50
51 /*!
52 * \brief Only gate stream tags with one specific key instead of all keys
53 *
54 * \details
55 * If set to "", all tags will be affected by the gate.
56 * If set to "foo", all tags with key different from "foo" will pass
57 * through.
58 */
59 virtual void set_single_key(const std::string& single_key) = 0;
60
61 /*!
62 * \brief Get the current single key.
63 */
64 virtual std::string single_key() const = 0;
65};
66
67} // namespace blocks
68} // namespace gr
69
70#endif /* INCLUDED_BLOCKS_TAG_GATE_H */
Control tag propagation.
Definition tag_gate.h:39
virtual void set_propagation(bool propagate_tags)=0
static sptr make(size_t item_size, bool propagate_tags=false)
boost::shared_ptr< tag_gate > sptr
Definition tag_gate.h:41
virtual std::string single_key() const =0
Get the current single key.
virtual void set_single_key(const std::string &single_key)=0
Only gate stream tags with one specific key instead of all keys.
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
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46