summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio/blocks/interleave.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/interleave.h')
-rw-r--r--gr-blocks/include/gnuradio/blocks/interleave.h82
1 files changed, 41 insertions, 41 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/interleave.h b/gr-blocks/include/gnuradio/blocks/interleave.h
index 5de75fcce4..8b4be52b26 100644
--- a/gr-blocks/include/gnuradio/blocks/interleave.h
+++ b/gr-blocks/include/gnuradio/blocks/interleave.h
@@ -27,52 +27,52 @@
#include <gnuradio/block.h>
namespace gr {
- namespace blocks {
+namespace blocks {
+
+/*!
+ * \brief interleave N inputs into a single output
+ * \ingroup stream_operators_blk
+ *
+ * \details
+ *
+ * This block interleaves blocks of samples. For each input
+ * connection, the samples are interleaved successively to the
+ * output connection. By default, the block interleaves a single
+ * sample from each input to the output unless blocksize is given
+ * in the constructor.
+ *
+ * \code
+ * blocksize = 1
+ * connections = 2
+ * input[0] = [a, c, e, g]
+ * input[1] = [b, d, f, h]
+ * output = [a, b, c, d, e, f, g, h]
+ * \endcode
+ *
+ * \code
+ * blocksize = 2
+ * connections = 2
+ * input[0] = [a, b, e, f]
+ * input[1] = [c, d, g, h]
+ * output = [a, b, c, d, e, f, g, h]
+ * \endcode
+ */
+class BLOCKS_API interleave : virtual public block
+{
+public:
+ // gr::blocks::interleave::sptr
+ typedef boost::shared_ptr<interleave> sptr;
/*!
- * \brief interleave N inputs into a single output
- * \ingroup stream_operators_blk
- *
- * \details
- *
- * This block interleaves blocks of samples. For each input
- * connection, the samples are interleaved successively to the
- * output connection. By default, the block interleaves a single
- * sample from each input to the output unless blocksize is given
- * in the constructor.
+ * Make a stream interleave block.
*
- * \code
- * blocksize = 1
- * connections = 2
- * input[0] = [a, c, e, g]
- * input[1] = [b, d, f, h]
- * output = [a, b, c, d, e, f, g, h]
- * \endcode
- *
- * \code
- * blocksize = 2
- * connections = 2
- * input[0] = [a, b, e, f]
- * input[1] = [c, d, g, h]
- * output = [a, b, c, d, e, f, g, h]
- * \endcode
+ * \param itemsize stream itemsize
+ * \param blocksize size of block of samples to interleave
*/
- class BLOCKS_API interleave : virtual public block
- {
- public:
- // gr::blocks::interleave::sptr
- typedef boost::shared_ptr<interleave> sptr;
-
- /*!
- * Make a stream interleave block.
- *
- * \param itemsize stream itemsize
- * \param blocksize size of block of samples to interleave
- */
- static sptr make(size_t itemsize, unsigned int blocksize = 1);
- };
+ static sptr make(size_t itemsize, unsigned int blocksize = 1);
+};
- } /* namespace blocks */
+} /* namespace blocks */
} /* namespace gr */
#endif /* INCLUDED_BLOCKS_INTERLEAVE_H */