GNU Radio v3.6.2-149-ga6d285d9 C++ API
gr_keep_m_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_GR_KEEP_M_IN_N_H
00024 #define INCLUDED_GR_KEEP_M_IN_N_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_block.h>
00028 
00029 class gr_keep_m_in_n;
00030 typedef boost::shared_ptr<gr_keep_m_in_n> gr_keep_m_in_n_sptr;
00031 
00032 GR_CORE_API gr_keep_m_in_n_sptr
00033 gr_make_keep_m_in_n (size_t item_size, int m, int n, int offset);
00034 
00035 
00036 /*!
00037  * \brief decimate a stream, keeping one item out of every n.
00038  * \ingroup slicedice_blk
00039  */
00040 class GR_CORE_API gr_keep_m_in_n : public gr_block
00041 {
00042   friend GR_CORE_API gr_keep_m_in_n_sptr
00043   gr_make_keep_m_in_n (size_t item_size, int m, int n, int offset);
00044 
00045   int   d_n;
00046   int   d_m;
00047   int   d_count;
00048   int   d_offset;
00049   int   d_itemsize;
00050 
00051  protected:
00052   gr_keep_m_in_n (size_t item_size, int m, int n, int offset);
00053   void forecast (int noutput_items, gr_vector_int &ninput_items_required);
00054 
00055  public:
00056   int general_work (int noutput_items,
00057             gr_vector_int &ninput_items,
00058                     gr_vector_const_void_star &input_items,
00059                     gr_vector_void_star &output_items);
00060 
00061     void set_offset(int offset);
00062     void set_n(int n){ d_n = n; }
00063     void set_m(int m){ d_m = m; }
00064 
00065 };
00066 
00067 #endif /* INCLUDED_GR_KEEP_M_IN_N_H */