GNU Radio Manual and C++ API Reference  3.10.9.1
The Free & Open Software Radio Ecosystem
annotator_alltoall.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_ALLTOALL_H
12 #define INCLUDED_GR_ANNOTATOR_ALLTOALL_H
13 
14 #include <gnuradio/blocks/api.h>
15 #include <gnuradio/sync_block.h>
16 
17 namespace gr {
18 namespace blocks {
19 
20 /*!
21  * \brief All-to-all 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 all-to-all
30  * policy.
31  *
32  * It also stores a copy of all tags it sees flow past it. These
33  * tags can be recalled externally with the data() member.
34  *
35  * This block is only meant for testing and showing how to use the tags.
36  */
38 {
39 public:
40  // gr::blocks::annotator_alltoall::sptr
41  typedef std::shared_ptr<annotator_alltoall> 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_ALLTOALL_H */
All-to-all stream annotator testing block. FOR TESTING PURPOSES ONLY.
Definition: annotator_alltoall.h:38
virtual std::vector< tag_t > data() const =0
std::shared_ptr< annotator_alltoall > sptr
Definition: annotator_alltoall.h:41
static sptr make(int when, size_t sizeof_stream_item)
synchronous 1:1 input to output with history
Definition: sync_block.h:26
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:18
GNU Radio logging wrapper.
Definition: basic_block.h:29