GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
keep_one_in_n.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012 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 3, 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_BLOCKS_KEEP_ONE_IN_N_H
24 #define INCLUDED_BLOCKS_KEEP_ONE_IN_N_H
25 
26 #include <gnuradio/blocks/api.h>
27 #include <gnuradio/block.h>
28 
29 namespace gr {
30  namespace blocks {
31 
32  /*!
33  * \brief decimate a stream, keeping one item out of every \p n.
34  * \ingroup stream_operators_blk
35  */
36  class BLOCKS_API keep_one_in_n : virtual public block
37  {
38  public:
39 
40  // gr::blocks::keep_one_in_n::sptr
41  typedef boost::shared_ptr<keep_one_in_n> sptr;
42 
43  /*!
44  * Make a keep one in n block.
45  *
46  * \param itemsize stream itemsize
47  * \param n block size in items
48  */
49  static sptr make(size_t itemsize, int n);
50 
51  virtual void set_n(int n) = 0;
52  };
53 
54  } /* namespace blocks */
55 } /* namespace gr */
56 
57 #endif /* INCLUDED_BLOCKS_KEEP_ONE_IN_N_H */
boost::shared_ptr< keep_one_in_n > sptr
Definition: keep_one_in_n.h:41
decimate a stream, keeping one item out of every n.
Definition: keep_one_in_n.h:36
Include this header to use the message passing features.
Definition: logger.h:131
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ...
Definition: block.h:60
BLOCKS_API size_t itemsize(vector_type type)