Editing Tag Debug

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
Bit bucket that prints out any tag received.
+
[[Category:Stub Docs]]
 +
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
  
This block collects all tags sent to it on all input ports and displays them to stdout in a formatted way.
+
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
 
 
This block otherwise acts as a NULL sink in that items from the input stream are ignored. It is designed to be able to attach to any block and watch all tags streaming out of that block for debugging purposes.
 
 
 
The tags from the last call to this work function are stored and can be retrieved using the function 'current_tags'.
 
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; Name
+
; Param 1 (''R'')
: The Name parameter is used to identify which debug sink generated the tag, so when connecting a block to this debug sink, an appropriate name is something that identifies the input block.
+
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
 
 
; Key filter
 
: Specifying a key will allow this block to filter out all other tags and only display tags that match the given key. This can help clean up the output and allow you to focus in on a particular tag of interest.
 
 
 
; Num Inputs
 
: Number of input streams
 
  
; Display (''R'')
+
; Param 2
: Print to stdout or not.
+
: blah blah blah
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 30: Line 21:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/tag_debug_impl.cc]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/tag_debug_impl.h]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/tag_debug.h]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_tag_debug.block.yml]
+
: [https://github.com/gnuradio/gnuradio TODO]

Please note that all contributions to GNU Radio are considered to be released under the Creative Commons Attribution-ShareAlike (see GNU Radio:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)