diff options
| author | Marcus Müller <marcus.mueller@ettus.com> | 2018-02-17 22:23:11 +0100 |
|---|---|---|
| committer | Marcus Müller <marcus.mueller@ettus.com> | 2018-02-17 22:58:07 +0100 |
| commit | c60fdbb75c7db6d000ef13dab66c393501840e21 (patch) | |
| tree | 4d57288bd1c7817a6814e0e201aa8b22f225bca7 | |
| parent | cb278e1237f23271bafbb6b7f7cd5e5c47ee28d8 (diff) | |
blocks: adding documentation for vector_sink's reserve_items param
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/vector_sink_X.h.t | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/vector_sink_X.h.t b/gr-blocks/include/gnuradio/blocks/vector_sink_X.h.t index 9a9faa469b..8d9c757862 100644 --- a/gr-blocks/include/gnuradio/blocks/vector_sink_X.h.t +++ b/gr-blocks/include/gnuradio/blocks/vector_sink_X.h.t @@ -41,6 +41,15 @@ namespace gr { // gr::blocks::@NAME@::sptr typedef boost::shared_ptr<@NAME@> sptr; + /*! + * \brief Make a new instance of the vector source, and return a shared pointer to it. + * \param vlen length of vector items + * \param reserve_items reserve space in the internal storage for this many items; + * the internal storage will still grow to accommodate more item + * if necessary, but setting this to a realistic value can avoid + * memory allocations during runtime, especially if you know a + * priori how many items you're going to store. + */ static sptr make(const int vlen = 1, const int reserve_items = 1024); //! Clear the data and tags containers. |