diff options
| author | Tom Rondeau <tom@trondeau.com> | 2014-02-23 13:58:46 -0500 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2014-02-23 16:17:25 -0500 |
| commit | ed7d84afba825aaabe7d940b135286c801234538 (patch) | |
| tree | 128f56392d2e1602f2e874a18b30984a858352f9 /gr-blocks/include/gnuradio/blocks/vector_source_X.h.t | |
| parent | 6dcb79842bb73d3c07efb9227dce52dd019b1605 (diff) | |
runtime: adds a gr.tag_utils.python_to_tag to convert formatted dicts/lists/tuples to tag_t objects.
blocks: adds documentation to vector_source block on how to use the python_to_tag to emit tags with the data stream.
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/vector_source_X.h.t')
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/vector_source_X.h.t | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/vector_source_X.h.t b/gr-blocks/include/gnuradio/blocks/vector_source_X.h.t index 9751514d7f..d5298e8b47 100644 --- a/gr-blocks/include/gnuradio/blocks/vector_source_X.h.t +++ b/gr-blocks/include/gnuradio/blocks/vector_source_X.h.t @@ -32,7 +32,7 @@ namespace gr { namespace blocks { /*! - * \brief Source that streams @TYPE@ items based on the input \data vector. + * \brief Source that streams @TYPE@ items based on the input \p data vector. * \ingroup misc_blk * * \details @@ -45,6 +45,23 @@ namespace gr { * The vector source can also produce stream tags with the * data. Pass in a vector of gr::tag_t objects and they will be * emitted based on the specified offset of the tag. + * + * GNU Radio provides a utility Python module in gr.tag_utils to + * convert between tags and Python objects: + * gr.tag_utils.python_to_tag. + * + * We can create tags as Python lists (or tuples) using the list + * structure [int offset, pmt key, pmt value, pmt srcid]. It is + * important to define the list/tuple with the values in the + * correct order and with the correct data type. A python + * dictionary can also be used using the keys: "offset", "key", + * "value", and "srcid" with the same data types as for the lists. + * + * When given a list of tags, the vector source will emit the tags + * repeatedly by updating the offset relative to the vector stream + * length. That is, if the vector has 500 items and a tag has an + * offset of 0, that tag will be placed on item 0, 500, 1000, + * 1500, etc. */ class BLOCKS_API @NAME@ : virtual public sync_block { |