GNU Radio 3.7.3 C++ API
stream_to_tagged_stream.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2013 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_TO_TAGGED_STREAM_H
24
#define INCLUDED_BLOCKS_STREAM_TO_TAGGED_STREAM_H
25
26
#include <
gnuradio/blocks/api.h
>
27
#include <
gnuradio/sync_block.h
>
28
29
namespace
gr {
30
namespace
blocks {
31
32
/*!
33
* \brief Converts a regular stream into a tagged stream.
34
* \ingroup blocks
35
*
36
* All this block does is add length tags in regular intervals.
37
* It can be used to connect a regular stream to a gr::tagged_stream_block.
38
*
39
* \b Careful: This block is meant to be connected directly to a tagged
40
* stream block. If there are blocks between this block and a tagged
41
* stream block, make sure they either don't change the rate, or modify
42
* the tag value to make sure the length tags actually represent the
43
* packet length.
44
*/
45
class
BLOCKS_API
stream_to_tagged_stream
:
virtual
public
gr::sync_block
46
{
47
public
:
48
typedef
boost::shared_ptr<stream_to_tagged_stream>
sptr
;
49
50
/*!
51
* \param itemsize Item size
52
* \param vlen Vector length of the input items. Note that one vector is one item.
53
* \param packet_len Number of items per tagged stream packet. One tag is written every \p packet_len items.
54
* \param len_tag_key Key of the length tag.
55
*/
56
static
sptr
make(
57
size_t
itemsize
,
58
int
vlen,
59
unsigned
packet_len,
60
const
std::string &len_tag_key
61
);
62
};
63
64
}
// namespace blocks
65
}
// namespace gr
66
67
#endif
/* INCLUDED_BLOCKS_STREAM_TO_TAGGED_STREAM_H */
68
gnuradio
gr-blocks
include
gnuradio
blocks
stream_to_tagged_stream.h
Generated by
1.8.3.1