GNU Radio 3.6.5 C++ API

stream_mux.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_BLOCKS_STREAM_MUX_H
00024 #define INCLUDED_BLOCKS_STREAM_MUX_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_block.h>
00028 #include <vector>
00029 
00030 namespace gr {
00031   namespace blocks {
00032 
00033     /*!
00034      * \brief Stream muxing block to multiplex many streams into
00035      * one with a specified format.
00036      * \ingroup stream_operators_blk
00037      *
00038      * \details
00039      * Muxes N streams together producing an output stream that
00040      * contains N0 items from the first stream, N1 items from the second,
00041      * etc. and repeats:
00042      *
00043      * [N0, N1, N2, ..., Nm, N0, N1, ...]
00044      */
00045     class BLOCKS_API stream_mux : virtual public gr_block
00046     {
00047     public:
00048       
00049       // gr::blocks::stream_mux::sptr
00050       typedef boost::shared_ptr<stream_mux> sptr;
00051 
00052       /*!
00053        * \brief Creates a stream muxing block to multiplex many streams into
00054        * one with a specified format.
00055        *
00056        * \param itemsize the item size of the stream
00057        * \param lengths  a vector (list/tuple) specifying the number of
00058        *                 items from each stream the mux together.
00059        *                 Warning: this requires that at least as many items
00060        *                 per stream are available or the system will wait
00061        *                 indefinitely for the items.
00062        *
00063        */
00064       static sptr make(size_t itemsize, const std::vector<int> &lengths);
00065     };
00066 
00067   } /* namespace blocks */
00068 } /* namespace gr */
00069 
00070 #endif /* INCLUDED_BLOCKS_STREAM_MUX_H */