GNU Radio C++ API Reference: annotator_1to1.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
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 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_GR_ANNOTATOR_1TO1_H
12#define INCLUDED_GR_ANNOTATOR_1TO1_H
13
14#include <gnuradio/blocks/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18namespace blocks {
19
20/*!
21 * \brief 1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY.
22 * \ingroup debug_tools_blk
23 *
24 * \details
25 * This block creates tags to be sent downstream every 10,000
26 * items it sees. The tags contain the name and ID of the
27 * instantiated block, use "seq" as a key, and have a counter that
28 * increments by 1 for every tag produced that is used as the
29 * tag's value. The tags are propagated using the 1-to-1 policy.
30 *
31 * It also stores a copy of all tags it sees flow past it. These
32 * tags can be recalled externally with the data() member.
33 *
34 * Warning: This block is only meant for testing and showing how to use the
35 * tags.
36 */
37 class BLOCKS_API annotator_1to1 : virtual public sync_block
38{
39public:
40 // gr::blocks::annotator_1to1::sptr
41 typedef std::shared_ptr<annotator_1to1> sptr;
42
43 static sptr make(int when, size_t sizeof_stream_item);
44
45 virtual std::vector<tag_t> data() const = 0;
46};
47
48} /* namespace blocks */
49} /* namespace gr */
50
51#endif /* INCLUDED_GR_ANNOTATOR_1TO1_H */
gr::blocks::annotator_1to1
1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY.
Definition annotator_1to1.h:38
gr::blocks::annotator_1to1::make
static sptr make(int when, size_t sizeof_stream_item)
gr::blocks::annotator_1to1::sptr
std::shared_ptr< annotator_1to1 > sptr
Definition annotator_1to1.h:41
gr::blocks::annotator_1to1::data
virtual std::vector< tag_t > data() const =0
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
BLOCKS_API
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
gr::blocks
Definition abs_blk.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h