GNU Radio 3.7.2git-47-g5cfb1151 C++ API
annotator_1to1.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2010,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_GR_ANNOTATOR_1TO1_H
24
#define INCLUDED_GR_ANNOTATOR_1TO1_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 1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY.
34
* \ingroup debug_tools_blk
35
*
36
* \details
37
* This block creates tags to be sent downstream every 10,000
38
* items it sees. The tags contain the name and ID of the
39
* instantiated block, use "seq" as a key, and have a counter that
40
* increments by 1 for every tag produced that is used as the
41
* tag's value. The tags are propagated using the 1-to-1 policy.
42
*
43
* It also stores a copy of all tags it sees flow past it. These
44
* tags can be recalled externally with the data() member.
45
*
46
* Warning: This block is only meant for testing and showing how to use the
47
* tags.
48
*/
49
class
BLOCKS_API
annotator_1to1
:
virtual
public
sync_block
50
{
51
public
:
52
// gr::blocks::annotator_1to1::sptr
53
typedef
boost::shared_ptr<annotator_1to1>
sptr
;
54
55
static
sptr
make(
int
when,
size_t
sizeof_stream_item);
56
57
virtual
std::vector<tag_t> data()
const
= 0;
58
};
59
60
}
/* namespace blocks */
61
}
/* namespace gr */
62
63
#endif
/* INCLUDED_GR_ANNOTATOR_1TO1_H */
gnuradio
gr-blocks
include
gnuradio
blocks
annotator_1to1.h
Generated by
1.8.1.1