diff options
| author | Tom Rondeau <tom@trondeau.com> | 2014-02-23 11:25:57 -0500 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2014-02-23 11:25:57 -0500 |
| commit | b5fcc18523caeafebbf117cf2c838e7974856966 (patch) | |
| tree | aac43972eb74614cded00b37d2d76c9113fa66a2 /docs/doxygen/other | |
| parent | 77c36d3cc3bb61581621dd61aab97a9b5d1b044e (diff) | |
tags: adds get_tags_in_window helper function for handling tags. Also updates some docs.
Diffstat (limited to 'docs/doxygen/other')
| -rw-r--r-- | docs/doxygen/other/stream_tags.dox | 27 |
1 files changed, 19 insertions, 8 deletions
diff --git a/docs/doxygen/other/stream_tags.dox b/docs/doxygen/other/stream_tags.dox index 2a03c9629c..851740984e 100644 --- a/docs/doxygen/other/stream_tags.dox +++ b/docs/doxygen/other/stream_tags.dox @@ -63,15 +63,26 @@ at <em>nitems_written(0)+i</em> for the 0th output port. The stream tags API consists of four functions, two to add and two to get the stream tags. These functions are: -\li add_item_tag: Adds an item tag to a particular output port using a +\li gr::block::add_item_tag: Adds an item tag to a particular output port using a gr::tag_t data type. -\li add_item_tag: Adds an item tag to a particular output port where -each value of the tag is explicitly given. -\li get_tags_in_range: Gets all tags from a particular input port between -a certain range of items (in absolute item time). -\li get_tags_in_range: Gets any tag that has a specified key from a -particular input port between a certain range of items (in absolute -item time). + +\li gr::block::add_item_tag: Adds an item tag to a particular output +port where each value of the tag is explicitly given. + +\li gr::block::get_tags_in_range: Gets all tags from a particular +input port between a certain range of items (in absolute item time). + +\li gr::block::get_tags_in_range: Gets any tag that has a specified +key from a particular input port between a certain range of items (in +absolute item time). + +\li gr::block::get_tags_in_window: Gets all tags from a particular +input port between a certain range of items (in relative item time +within the work function). + +\li gr::block::get_tags_in_range: Gets any tag that has a specified +key from a particular input port between a certain range of items (in +relative item time within the work function). \subsection add_item_tag Adding a Tag to a Stream |