GNU Radio 3.6.4 C++ API
gr_annotator_1to1.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2010 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 <
gr_core_api.h
>
27
#include <
gr_sync_block.h
>
28
29
class
gr_annotator_1to1
;
30
typedef
boost::shared_ptr<gr_annotator_1to1>
gr_annotator_1to1_sptr
;
31
32
// public constructor
33
GR_CORE_API
gr_annotator_1to1_sptr
34
gr_make_annotator_1to1
(
int
when,
size_t
sizeof_stream_item);
35
36
/*!
37
* \brief 1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY.
38
*
39
* This block creates tags to be sent downstream every 10,000 items it sees. The
40
* tags contain the name and ID of the instantiated block, use "seq" as a key,
41
* and have a counter that increments by 1 for every tag produced that is used
42
* as the tag's value. The tags are propagated using the 1-to-1 policy.
43
*
44
* It also stores a copy of all tags it sees flow past it. These tags can be
45
* recalled externally with the data() member.
46
*
47
* This block is only meant for testing and showing how to use the tags.
48
*/
49
class
GR_CORE_API
gr_annotator_1to1
:
public
gr_sync_block
50
{
51
public
:
52
~
gr_annotator_1to1
();
53
int
work
(
int
noutput_items,
54
gr_vector_const_void_star
&input_items,
55
gr_vector_void_star
&output_items);
56
57
std::vector<gr_tag_t> data()
const
58
{
59
return
d_stored_tags;
60
}
61
62
protected
:
63
gr_annotator_1to1
(
int
when,
size_t
sizeof_stream_item);
64
65
private
:
66
size_t
d_itemsize;
67
uint64_t
d_when;
68
uint64_t
d_tag_counter;
69
std::vector<gr_tag_t> d_stored_tags;
70
71
friend
GR_CORE_API
gr_annotator_1to1_sptr
72
gr_make_annotator_1to1
(
int
when,
size_t
sizeof_stream_item);
73
};
74
75
#endif
gnuradio
gnuradio-core
src
lib
general
gr_annotator_1to1.h
Generated by
1.8.1.1