PDU Filter: 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 note for 3.10)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Propagates only PDUs containing a specific Key-Value pair in meta.
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.
<b>Note for 3.10</b> This block has been moved from gr-blocks to gr-pdu, which causes a name change of the id. See [[Porting_Existing_Flowgraphs_to_a_Newer_Version#PDU_blocks_moved_from_gr-blocks_to_gr-pdu]] for details.


== 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'')
; Key (''R'')
: 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).
: The key to look for.


; Param 2
; Value (''R'')
: blah blah blah
: The value to look for.
 
; Invert Filter (''R'')
: Invert the filter function to propagate all pdus except the ones containing the Key-Value pair.


== Example Flowgraph ==
== Example Flowgraph ==
Line 21: Line 23:


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


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/maint-3.8/gr-blocks/lib/pdu_filter_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/maint-3.8/gr-blocks/include/gnuradio/blocks/pdu_filter.h]


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

Latest revision as of 14:12, 27 January 2022

Propagates only PDUs containing a specific Key-Value pair in meta.

Note for 3.10 This block has been moved from gr-blocks to gr-pdu, which causes a name change of the id. See Porting_Existing_Flowgraphs_to_a_Newer_Version#PDU_blocks_moved_from_gr-blocks_to_gr-pdu for details.

Parameters

(R): Run-time adjustable

Key (R)
The key to look for.
Value (R)
The value to look for.
Invert Filter (R)
Invert the filter function to propagate all pdus except the ones containing the Key-Value pair.

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.

Source Files

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]
Retrieved from "https://wiki.gnuradio.org/index.php?title=PDU_Filter&oldid=10906"