GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
annotator_raw.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_RAW_H
24#define INCLUDED_GR_ANNOTATOR_RAW_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28#include <gnuradio/tags.h>
29
30namespace gr {
31namespace blocks {
32
33/*!
34 * \brief raw stream annotator testing block.
35 * \ingroup debug_tools_blk
36 *
37 * \details
38 * This block creates arbitrary tags to be sent downstream gnuradio/blocks
39 * to be sent are set manually via accessor methods and are sent
40 * only once.
41 *
42 * This block is intended for testing of tag related gnuradio/blocks
43 */
44class BLOCKS_API annotator_raw : virtual public sync_block
45{
46public:
47 // gr::blocks::annotator_raw::sptr
48 typedef boost::shared_ptr<annotator_raw> sptr;
49
50 static sptr make(size_t sizeof_stream_item);
51
52 // insert a tag to be added
53 virtual void add_tag(uint64_t offset, pmt::pmt_t key, pmt::pmt_t val) = 0;
54};
55
56} /* namespace blocks */
57} /* namespace gr */
58
59#endif /* INCLUDED_GR_ANNOTATOR_RAW_H */
raw stream annotator testing block.
Definition: annotator_raw.h:45
boost::shared_ptr< annotator_raw > sptr
Definition: annotator_raw.h:48
static sptr make(size_t sizeof_stream_item)
virtual void add_tag(uint64_t offset, pmt::pmt_t key, pmt::pmt_t val)=0
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45
boost::intrusive_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting). See http://www.boost....
Definition: pmt.h:56