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
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 
29 namespace gr {
30  namespace blocks {
31 
32  /*!
33  * \brief Control tag propagation.
34  * \ingroup blocks
35  *
36  * Use this block to stop tags from propagating.
37  */
38  class BLOCKS_API tag_gate : virtual public gr::sync_block
39  {
40  public:
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  } // namespace blocks
53 } // namespace gr
54 
55 #endif /* INCLUDED_BLOCKS_TAG_GATE_H */
56 
boost::shared_ptr< tag_gate > sptr
Definition: tag_gate.h:41
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
Control tag propagation.Use this block to stop tags from propagating.
Definition: tag_gate.h:38