diff options
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/stream_mux.h')
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/stream_mux.h | 59 |
1 files changed, 29 insertions, 30 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/stream_mux.h b/gr-blocks/include/gnuradio/blocks/stream_mux.h index 941c186b3f..9dc0386795 100644 --- a/gr-blocks/include/gnuradio/blocks/stream_mux.h +++ b/gr-blocks/include/gnuradio/blocks/stream_mux.h @@ -28,43 +28,42 @@ #include <vector> namespace gr { - namespace blocks { +namespace blocks { + +/*! + * \brief Stream muxing block to multiplex many streams into + * one with a specified format. + * \ingroup stream_operators_blk + * + * \details + * Muxes N streams together producing an output stream that + * contains N0 items from the first stream, N1 items from the second, + * etc. and repeats: + * + * [N0, N1, N2, ..., Nm, N0, N1, ...] + */ +class BLOCKS_API stream_mux : virtual public block +{ +public: + // gr::blocks::stream_mux::sptr + typedef boost::shared_ptr<stream_mux> sptr; /*! - * \brief Stream muxing block to multiplex many streams into + * \brief Creates a stream muxing block to multiplex many streams into * one with a specified format. - * \ingroup stream_operators_blk * - * \details - * Muxes N streams together producing an output stream that - * contains N0 items from the first stream, N1 items from the second, - * etc. and repeats: + * \param itemsize the item size of the stream + * \param lengths a vector (list/tuple) specifying the number of + * items from each stream the mux together. + * Warning: this requires that at least as many items + * per stream are available or the system will wait + * indefinitely for the items. * - * [N0, N1, N2, ..., Nm, N0, N1, ...] */ - class BLOCKS_API stream_mux : virtual public block - { - public: - - // gr::blocks::stream_mux::sptr - typedef boost::shared_ptr<stream_mux> sptr; - - /*! - * \brief Creates a stream muxing block to multiplex many streams into - * one with a specified format. - * - * \param itemsize the item size of the stream - * \param lengths a vector (list/tuple) specifying the number of - * items from each stream the mux together. - * Warning: this requires that at least as many items - * per stream are available or the system will wait - * indefinitely for the items. - * - */ - static sptr make(size_t itemsize, const std::vector<int> &lengths); - }; + static sptr make(size_t itemsize, const std::vector<int>& lengths); +}; - } /* namespace blocks */ +} /* namespace blocks */ } /* namespace gr */ #endif /* INCLUDED_BLOCKS_STREAM_MUX_H */ |