GNU Radio 3.7.1 C++ API
keep_one_in_n.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012 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_KEEP_ONE_IN_N_H
00024 #define INCLUDED_BLOCKS_KEEP_ONE_IN_N_H
00025 
00026 #include <gnuradio/blocks/api.h>
00027 #include <gnuradio/block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief decimate a stream, keeping one item out of every \p n.
00034      * \ingroup stream_operators_blk
00035      */
00036     class BLOCKS_API keep_one_in_n : virtual public block
00037     {
00038     public:
00039       
00040       // gr::blocks::keep_one_in_n::sptr
00041       typedef boost::shared_ptr<keep_one_in_n> sptr;
00042 
00043       /*!
00044        * Make a keep one in n block.
00045        *
00046        * \param itemsize stream itemsize
00047        * \param n block size in items
00048        */
00049       static sptr make(size_t itemsize, int n);
00050 
00051       virtual void set_n(int n) = 0;
00052     };
00053 
00054   } /* namespace blocks */
00055 } /* namespace gr */
00056 
00057 #endif /* INCLUDED_BLOCKS_KEEP_ONE_IN_N_H */