Struct Variable: 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...")
 
No edit summary
 
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
This is a simple struct/record like variable.
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.
Attribute/field names can be specified in the tab 'Fields'.
For each non-empty field a parameter with type raw is shown.
Value access via the dot operator, e.g. "variable_struct_0.field0"


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
; Param 1 (''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).
; Param 2
: blah blah blah


== Example Flowgraph ==
== Example Flowgraph ==
Line 19: Line 13:


== Source Files ==
== Source Files ==
; C++ fileshttps://wiki.gnuradio.org/index.php/SISO
: [https://github.com/gnuradio/gnuradio TODO]
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
; 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/master/grc/blocks/variable_struct.block.yml.py]

Latest revision as of 14:45, 11 September 2019

This is a simple struct/record like variable.

Attribute/field names can be specified in the tab 'Fields'. For each non-empty field a parameter with type raw is shown. Value access via the dot operator, e.g. "variable_struct_0.field0"

Parameters

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

Block definition
[1]
Retrieved from "https://wiki.gnuradio.org/index.php?title=Struct_Variable&oldid=6144"