Editing Parameter

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
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.
 +
 +
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.
 +
 +
 +
 +
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
  
 
== Parameters ==
 
== Parameters ==
; Label
+
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
: Label that will show up. Leave blank to use the parameter id as the label.
 
  
; Value
+
; Param 1 (''R'')
: Value.  Note, the parameter value cannot depend on any variables.
+
: 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).
  
; Type
+
; Param 2
: When type is not None, this parameter also becomes a command line option of the form:  -[short_id] --[id] [value]
+
: blah blah blah
: The Short ID field may be left blank.
 
  
; Show
+
== Example Flowgraph ==
: To disable showing the parameter on the hierarchical block in GRC, use "Only in Properties" option
+
 
 +
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 ==
  
== Example Flowgraph ==
+
; C++ fileshttps://wiki.gnuradio.org/index.php/SISO
 +
 
 +
: [https://github.com/gnuradio/gnuradio TODO]
  
This flowgraph can be found at [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/examples/fecapi_ldpc_encoders.grc]
+
; Header files
 +
: [https://github.com/gnuradio/gnuradio TODO]
  
[[File:Fecapi_ldpc_encoders_fg.png|800px]]
+
; Public header files
 +
: [https://github.com/gnuradio/gnuradio TODO]
  
== Source Files ==
+
; Block definition
 +
: [https://github.com/gnuradio/gnuradio TODO]

Please note that all contributions to GNU Radio are considered to be released under the Creative Commons Attribution-ShareAlike (see GNU Radio:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)