GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
vector_sink.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2008,2009,2013,2018 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
24#ifndef VECTOR_SINK_H
25#define VECTOR_SINK_H
26
27#include <gnuradio/blocks/api.h>
28#include <gnuradio/sync_block.h>
29#include <cstdint>
30
31namespace gr {
32namespace blocks {
33
34/*!
35 * \brief T sink that writes to a vector
36 * \ingroup debug_tools_blk
37 */
38template <class T>
39class BLOCKS_API vector_sink : virtual public sync_block
40{
41public:
42 // gr::blocks::vector_sink::sptr
43 typedef boost::shared_ptr<vector_sink<T>> sptr;
44
45 /*!
46 * \brief Make a new instance of the vector source, and return a shared pointer to it.
47 * \param vlen length of vector items
48 * \param reserve_items reserve space in the internal storage for this many items;
49 * the internal storage will still grow to accommodate more item
50 * if necessary, but setting this to a realistic value can avoid
51 * memory allocations during runtime, especially if you know a
52 * priori how many items you're going to store.
53 */
54 static sptr make(const unsigned int vlen = 1, const int reserve_items = 1024);
55
56 //! Clear the data and tags containers.
57 virtual void reset() = 0;
58 virtual std::vector<T> data() const = 0;
59 virtual std::vector<tag_t> tags() const = 0;
60};
61
67} /* namespace blocks */
68} /* namespace gr */
69
70#endif /* VECTOR_SINK_H */
T sink that writes to a vector.
Definition vector_sink.h:40
virtual std::vector< T > data() const =0
static sptr make(const unsigned int vlen=1, const int reserve_items=1024)
Make a new instance of the vector source, and return a shared pointer to it.
virtual void reset()=0
Clear the data and tags containers.
boost::shared_ptr< vector_sink< T > > sptr
Definition vector_sink.h:43
virtual std::vector< tag_t > tags() const =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
vector_sink< float > vector_sink_f
Definition vector_sink.h:65
vector_sink< gr_complex > vector_sink_c
Definition vector_sink.h:66
vector_sink< std::int16_t > vector_sink_s
Definition vector_sink.h:63
vector_sink< std::uint8_t > vector_sink_b
Definition vector_sink.h:62
vector_sink< std::int32_t > vector_sink_i
Definition vector_sink.h:64
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46