GNU Radio 3.6.5.1 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 <blocks/api.h>
27 #include <gr_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  *
35  * \details
36  * This block creates tags to be sent downstream every 10,000
37  * items it sees. The tags contain the name and ID of the
38  * instantiated block, use "seq" as a key, and have a counter that
39  * increments by 1 for every tag produced that is used as the
40  * tag's value. The tags are propagated using the 1-to-1 policy.
41  *
42  * It also stores a copy of all tags it sees flow past it. These
43  * tags can be recalled externally with the data() member.
44  *
45  * This block is only meant for testing and showing how to use the tags.
46  */
47  class BLOCKS_API annotator_1to1 : virtual public gr_sync_block
48  {
49  public:
50  // gr::blocks::annotator_1to1::sptr
52 
53  static sptr make(int when, size_t sizeof_stream_item);
54 
55  virtual std::vector<gr_tag_t> data() const = 0;
56  };
57 
58  } /* namespace blocks */
59 } /* namespace gr */
60 
61 #endif /* INCLUDED_GR_ANNOTATOR_1TO1_H */