GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
tagged_stream_align.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/* Copyright 2012 Free Software Foundation, Inc.
3 *
4 * This file is part of GNU Radio
5 *
6 * GNU Radio is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
9 * any later version.
10 *
11 * GNU Radio is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with GNU Radio; see the file COPYING. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street,
19 * Boston, MA 02110-1301, USA.
20 */
21
22#ifndef INCLUDED_TAGGED_STREAM_ALIGN_H
23#define INCLUDED_TAGGED_STREAM_ALIGN_H
24
25#include <gnuradio/block.h>
26#include <gnuradio/blocks/api.h>
27
28namespace gr {
29namespace blocks {
30
31/*!
32 * \brief Align a stream to a tagged stream item
33 * \ingroup stream_operators_blk
34 *
35 * \details
36 * Takes an unaligned stream of tagged stream items and aligns to the first item
37 */
38class BLOCKS_API tagged_stream_align : virtual public block
39{
40public:
41 typedef boost::shared_ptr<tagged_stream_align> sptr;
42
43 /*!
44 * Make a tagged stream align
45 *
46 * \param itemsize The size (in bytes) of the item datatype.
47 * \param lengthtagname Name of the TSB's length tag key.
48 */
49 static sptr make(size_t itemsize, const std::string& lengthtagname);
50};
51
52} // namespace blocks
53} // namespace gr
54
55#endif /* INCLUDED_TAGGED_STREAM_ALIGN_H */
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
Align a stream to a tagged stream item.
Definition: tagged_stream_align.h:39
boost::shared_ptr< tagged_stream_align > sptr
Definition: tagged_stream_align.h:41
static sptr make(size_t itemsize, const std::string &lengthtagname)
#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