Variable: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
This block maps a value to a unique variable.  You can use the variable in the parameter field of another block simply by using the Variable Block's ID.
This block maps a value to a unique variable.  You can use the variable in the parameter field of another block simply by using the Variable Block's ID.


Line 6: Line 5:


Also see the [[Parameter]] Block.
Also see the [[Parameter]] Block.
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.


== 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'')
; ID
: Description of parameter, provide any tips or recommended valuesNote that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
: ID of variable nameUse this to reference the variable in other block's fields.  


; Param 2
; Value (''R'')
: blah blah blah
: Value, which can be changed in realtime.


== Example Flowgraph ==
== Example Flowgraph ==

Revision as of 05:06, 21 July 2019

This block maps a value to a unique variable. You can use the variable in the parameter field of another block simply by using the Variable Block's ID.

The variable block is a convenient way to have one value that is used in a bunch of different places (i.e. parameters of other blocks) while being able to easily change it.

Also see the Parameter Block.

Parameters

(R): Run-time adjustable

ID
ID of variable name. Use this to reference the variable in other block's fields.
Value (R)
Value, which can be changed in realtime.

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