GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
vector_sink_s.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 // WARNING: this file is machine generated. Edits will be overwritten
24 
25 #ifndef INCLUDED_BLOCKS_VECTOR_SINK_S_H
26 #define INCLUDED_BLOCKS_VECTOR_SINK_S_H
27 
28 #include <gnuradio/blocks/api.h>
29 #include <gnuradio/sync_block.h>
30 
31 namespace gr {
32  namespace blocks {
33 
34  /*!
35  * \brief short sink that writes to a vector
36  * \ingroup debug_tools_blk
37  */
38  class BLOCKS_API vector_sink_s : virtual public sync_block
39  {
40  public:
41  // gr::blocks::vector_sink_s::sptr
42  typedef boost::shared_ptr<vector_sink_s> sptr;
43 
44  /*!
45  * \brief Make a new instance of the vector source, and return a shared pointer to it.
46  * \param vlen length of vector items
47  * \param reserve_items reserve space in the internal storage for this many items;
48  * the internal storage will still grow to accommodate more item
49  * if necessary, but setting this to a realistic value can avoid
50  * memory allocations during runtime, especially if you know a
51  * priori how many items you're going to store.
52  */
53  static sptr make(const int vlen = 1, const int reserve_items = 1024);
54 
55  //! Clear the data and tags containers.
56  virtual void reset() = 0;
57  virtual std::vector<short> data() const = 0;
58  virtual std::vector<tag_t> tags() const = 0;
59  };
60 
61  } /* namespace blocks */
62 } /* namespace gr */
63 
64 #endif /* INCLUDED_BLOCKS_VECTOR_SINK_S_H */
boost::shared_ptr< vector_sink_s > sptr
Definition: vector_sink_s.h:42
Include this header to use the message passing features.
Definition: logger.h:695
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
short sink that writes to a vector
Definition: vector_sink_s.h:38