Difference between revisions of "Parameter"

From GNU Radio
Jump to: navigation, search
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.
  
Line 15: Line 14:
 
To disable showing the parameter on the hierarchical block in GRC, use Only in Properties option in the Show field.
 
To disable showing the parameter on the hierarchical block in GRC, use Only in Properties option in the Show field.
  
 +
== 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.
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
; Type
 
+
: When type is not None, this parameter also becomes a command line option of the form:  -[short_id] --[id] [value]
== Parameters ==
+
: The Short ID field may be left blank.
(''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
+
; Show
: blah blah blah
+
: To disable showing the parameter on the hierarchical block in GRC, use "Only in Properties" option
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==

Revision as of 04:52, 21 July 2019

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.

Leave the label 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:

-[short_id] --[id] [value]

The Short ID field may be left blank.

To disable showing the parameter on the hierarchical block in GRC, use Only in Properties option in the Show field.

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

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++ fileshttps
//wiki.gnuradio.org/index.php/SISO
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO