Tag Gate: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
(add Parameters, Source files)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Control tag propagation.
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.


As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
Use this block to stop tags from propagating.


== 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>


; Param 1 (''R'')
; Item Type
: 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).
: options: [complex, float, int, short, byte]


; Param 2
; Vector Length
: blah blah blah
: default: '1'
 
; Propagate tags
: options: ['Yes', 'No']
: default: 'No'
 
; Single key (''R'')
: Key of the tags to stop
: default: '""' stops all tags


== Example Flowgraph ==
== Example Flowgraph ==


Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.
In this flowgraph, the Tag Gate can simulate transmission through a medium which does not pass tags. In this case, it separates the transmitter from the receiver.
 
[[File:Fec_coder_payload_fg.png|800px]]


== Source Files ==
== Source Files ==


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/tag_gate_impl.cc tag_gate_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/tag_gate_impl.h tag_gate_impl.h]
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_tag_gate.block.yml blocks_tag_gate.block.yml]

Latest revision as of 18:32, 1 August 2024

Control tag propagation.

Use this block to stop tags from propagating.

Parameters

(R): Run-time adjustable

Item Type
options: [complex, float, int, short, byte]
Vector Length
default: '1'
Propagate tags
options: ['Yes', 'No']
default: 'No'
Single key (R)
Key of the tags to stop
default: '""' stops all tags

Example Flowgraph

In this flowgraph, the Tag Gate can simulate transmission through a medium which does not pass tags. In this case, it separates the transmitter from the receiver.

Fec coder payload fg.png

Source Files

C++ files
tag_gate_impl.cc
Header files
tag_gate_impl.h
Block definition
blocks_tag_gate.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=Tag_Gate&oldid=14514"