GNU Radio 3.6.5 C++ API

tag_gate.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_BLOCKS_TAG_GATE_H
00024 #define INCLUDED_BLOCKS_TAG_GATE_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief Control tag propagation.
00034      * \ingroup blocks
00035      *
00036      * Use this block to stop tags from propagating.
00037      */
00038     class BLOCKS_API tag_gate : virtual public gr_sync_block
00039     {
00040      public:
00041       typedef boost::shared_ptr<tag_gate> sptr;
00042 
00043       virtual void set_propagation(bool propagate_tags) = 0;
00044 
00045       /*!
00046        * \param item_size Item size
00047        * \param propagate_tags Set this to true to allow tags to pass through this block.
00048        */
00049       static sptr make(size_t item_size, bool propagate_tags=false);
00050     };
00051 
00052   } // namespace blocks
00053 } // namespace gr
00054 
00055 #endif /* INCLUDED_BLOCKS_TAG_GATE_H */
00056