Difference between revisions of "Parameter"

From GNU Radio
Jump to: navigation, search
(Example Flowgraph)
 
(4 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
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 ==
 +
 
 +
This flowgraph can be found at [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/examples/fecapi_ldpc_encoders.grc]
 +
 
 +
[[File:Fecapi_ldpc_encoders_fg.png|800px]]
 +
 
 +
== Source Files ==

Latest revision as of 13:50, 3 December 2020

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[edit]

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[edit]

This flowgraph can be found at [1]

Fecapi ldpc encoders fg.png

Source Files[edit]