Parameter: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
This block represents a parameter to the flow graph. A parameter can be used to pass command line arguments into a top block. Or, parameters can pass arguments into an instantiated hierarchical block.  If you don't care about command line arguments, see the [[Variable]] Block.
This block represents a parameter to the flow graph. A parameter can be used to pass command line arguments into a top block. Or, parameters can pass arguments into an instantiated hierarchical block.  If you don't care about command line arguments, see the [[Variable]] Block.


The parameter value cannot depend on any variables.
The parameter value cannot depend on any variables.


Leave the label blank to use the parameter id as the label.
== Parameters ==
; Label
: Label that will show up.  Leave blank to use the parameter id as the label.


When type is not None, this parameter also becomes a command line option of the form:
; Value
: Value.  Note, the parameter value cannot depend on any variables.


-[short_id] --[id] [value]
; Type
: When type is not None, this parameter also becomes a command line option of the form:  -[short_id] --[id] [value]
: The Short ID field may be left blank.


The Short ID field may be left blank.
; Show
: To disable showing the parameter on the hierarchical block in GRC, use "Only in Properties" option


To disable showing the parameter on the hierarchical block in GRC, use Only in Properties option in the Show field.
== Example Flowgraph ==
 
 
 
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
 
== 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 ==
This flowgraph can be found at [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/examples/fecapi_ldpc_encoders.grc]


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.
[[File:Fecapi_ldpc_encoders_fg.png|800px]]


== 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/main/grc/blocks/parameter.block.yml parameter.block.yml]

Latest revision as of 06:37, 7 June 2022

This block represents a parameter to the flow graph. A parameter can be used to pass command line arguments into a top block. Or, parameters can pass arguments into an instantiated hierarchical block. If you don't care about command line arguments, see the Variable Block.

The parameter value cannot depend on any variables.

Parameters

Label
Label that will show up. Leave blank to use the parameter id as the label.
Value
Value. Note, the parameter value cannot depend on any variables.
Type
When type is not None, this parameter also becomes a command line option of the form: -[short_id] --[id] [value]
The Short ID field may be left blank.
Show
To disable showing the parameter on the hierarchical block in GRC, use "Only in Properties" option

Example Flowgraph

This flowgraph can be found at [1]

Fecapi ldpc encoders fg.png

Source Files

Block definition
parameter.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=Parameter&oldid=12330"