Skip to content

Commit c60fdbb

Browse files
committed
blocks: adding documentation for vector_sink's reserve_items param
1 parent cb278e1 commit c60fdbb

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

gr-blocks/include/gnuradio/blocks/vector_sink_X.h.t

+9
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,15 @@ namespace gr {
4141
// gr::blocks::@NAME@::sptr
4242
typedef boost::shared_ptr<@NAME@> sptr;
4343

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+
*/
4453
static sptr make(const int vlen = 1, const int reserve_items = 1024);
4554

4655
//! Clear the data and tags containers.

0 commit comments

Comments
 (0)