GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
stream_mux.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_STREAM_MUX_H
24#define INCLUDED_BLOCKS_STREAM_MUX_H
25
26#include <gnuradio/block.h>
27#include <gnuradio/blocks/api.h>
28#include <vector>
29
30namespace gr {
31namespace blocks {
32
33/*!
34 * \brief Stream muxing block to multiplex many streams into
35 * one with a specified format.
36 * \ingroup stream_operators_blk
37 *
38 * \details
39 * Muxes N streams together producing an output stream that
40 * contains N0 items from the first stream, N1 items from the second,
41 * etc. and repeats:
42 *
43 * [N0, N1, N2, ..., Nm, N0, N1, ...]
44 */
45class BLOCKS_API stream_mux : virtual public block
46{
47public:
48 // gr::blocks::stream_mux::sptr
49 typedef boost::shared_ptr<stream_mux> sptr;
50
51 /*!
52 * \brief Creates a stream muxing block to multiplex many streams into
53 * one with a specified format.
54 *
55 * \param itemsize the item size of the stream
56 * \param lengths a vector (list/tuple) specifying the number of
57 * items from each stream the mux together.
58 * Warning: this requires that at least as many items
59 * per stream are available or the system will wait
60 * indefinitely for the items.
61 *
62 */
63 static sptr make(size_t itemsize, const std::vector<int>& lengths);
64};
65
66} /* namespace blocks */
67} /* namespace gr */
68
69#endif /* INCLUDED_BLOCKS_STREAM_MUX_H */
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
Stream muxing block to multiplex many streams into one with a specified format.
Definition: stream_mux.h:46
static sptr make(size_t itemsize, const std::vector< int > &lengths)
Creates a stream muxing block to multiplex many streams into one with a specified format.
boost::shared_ptr< stream_mux > sptr
Definition: stream_mux.h:49
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
BLOCKS_API size_t itemsize(vector_type type)
Include this header to use the message passing features.
Definition: basic_block.h:45