Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_keep_one_in_n.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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 2, 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_GR_KEEP_ONE_IN_N_H
24 #define INCLUDED_GR_KEEP_ONE_IN_N_H
25
26 #include <gr_sync_decimator.h>
27
28 class gr_keep_one_in_n;
29 typedef boost::shared_ptr<gr_keep_one_in_n> gr_keep_one_in_n_sptr;
30
31 gr_keep_one_in_n_sptr 
32 gr_make_keep_one_in_n (size_t item_size, int n);
33
34
35 /*!
36  * \brief decimate a stream, keeping one item out of every n.
37  * \ingroup block
38  */
39 class gr_keep_one_in_n : public gr_block
40 {
41   friend gr_keep_one_in_n_sptr
42   gr_make_keep_one_in_n (size_t item_size, int n);
43
44   int   d_n;
45   int   d_count;
46
47  protected:
48   gr_keep_one_in_n (size_t item_size, int n);
49
50  public:
51   int general_work (int noutput_items,
52                     gr_vector_int &ninput_items,
53                     gr_vector_const_void_star &input_items,
54                     gr_vector_void_star &output_items);
55
56   void set_n(int n);
57
58 };
59
60 #endif /* INCLUDED_GR_KEEP_ONE_IN_N_H */