GNU Radio 3.4.0 C++ API
gr_keep_one_in_n.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004 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_ONE_IN_N_H
00024 #define INCLUDED_GR_KEEP_ONE_IN_N_H
00025 
00026 #include <gr_sync_decimator.h>
00027 
00028 class gr_keep_one_in_n;
00029 typedef boost::shared_ptr<gr_keep_one_in_n> gr_keep_one_in_n_sptr;
00030 
00031 gr_keep_one_in_n_sptr 
00032 gr_make_keep_one_in_n (size_t item_size, int n);
00033 
00034 
00035 /*!
00036  * \brief decimate a stream, keeping one item out of every n.
00037  * \ingroup slicedice_blk
00038  */
00039 class gr_keep_one_in_n : public gr_block
00040 {
00041   friend gr_keep_one_in_n_sptr
00042   gr_make_keep_one_in_n (size_t item_size, int n);
00043 
00044   int   d_n;
00045   int   d_count;
00046 
00047  protected:
00048   gr_keep_one_in_n (size_t item_size, int n);
00049 
00050  public:
00051   int general_work (int noutput_items,
00052                     gr_vector_int &ninput_items,
00053                     gr_vector_const_void_star &input_items,
00054                     gr_vector_void_star &output_items);
00055 
00056   void set_n(int n);
00057 
00058 };
00059 
00060 #endif /* INCLUDED_GR_KEEP_ONE_IN_N_H */