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
interleave.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012,2014 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_INTERLEAVE_H
24 #define INCLUDED_BLOCKS_INTERLEAVE_H
25 
26 #include <gnuradio/blocks/api.h>
27 #include <gnuradio/block.h>
28 
29 namespace gr {
30  namespace blocks {
31 
32  /*!
33  * \brief interleave N inputs into a single output
34  * \ingroup stream_operators_blk
35  *
36  * \details
37  *
38  * This block interleaves blocks of samples. For each input
39  * connection, the samples are interleaved successively to the
40  * output connection. By default, the block interleaves a single
41  * sample from eahc input to the output unless blocksize is given
42  * in the constructor.
43  *
44  * \code
45  * blocksize = 1
46  * connections = 2
47  * input[0] = [a, c, e, g]
48  * input[1] = [b, d, f, h]
49  * output = [a, b, c, d, e, f, g, h]
50  * \endcode
51  *
52  * \code
53  * blocksize = 2
54  * connections = 2
55  * input[0] = [a, b, e, f]
56  * input[1] = [c, d, g, h]
57  * output = [a, b, c, d, e, f, g, h]
58  * \endcode
59  */
60  class BLOCKS_API interleave : virtual public block
61  {
62  public:
63  // gr::blocks::interleave::sptr
64  typedef boost::shared_ptr<interleave> sptr;
65 
66  /*!
67  * Make a stream interleave block.
68  *
69  * \param itemsize stream itemsize
70  * \param blocksize size of block of samples to interleave
71  */
72  static sptr make(size_t itemsize, unsigned int blocksize = 1);
73  };
74 
75  } /* namespace blocks */
76 } /* namespace gr */
77 
78 #endif /* INCLUDED_BLOCKS_INTERLEAVE_H */
interleave N inputs into a single output
Definition: interleave.h:60
Include this header to use the message passing features.
Definition: logger.h:131
boost::shared_ptr< interleave > sptr
Definition: interleave.h:64
#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)