Merging r11186:11273 from grc branch.

[debian/gnuradio] / grc / blocks / parameter.xml

diff --git a/grc/blocks/parameter.xml b/grc/blocks/parameter.xml
new file mode 100644 (file)
index 0000000..d3bab94
--- /dev/null
+++ b/grc/blocks/parameter.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0"?>
+<!--
+###################################################
+##Parameter block: a grc variable with key, value
+###################################################
+ -->
+<block>
+       <name>Parameter</name>
+       <key>parameter</key>
+       <var_make>self.$(id) = $(id)</var_make>
+       <make>$value</make>
+       <param>
+               <name>Label</name>
+               <key>label</key>
+               <value></value>
+               <type>string</type>
+               <hide>#if $label() then 'none' else 'part'#</hide>
+       </param>
+       <param>
+               <name>Value</name>
+               <key>value</key>
+               <value>0</value>
+               <type>$type.type</type>
+       </param>
+       <param>
+               <name>Type</name>
+               <key>type</key>
+               <value></value>
+               <type>enum</type>
+               <hide>$type.hide</hide>
+               <option>
+                       <name>None</name>
+                       <key></key>
+                       <opt>type:raw</opt>
+                       <opt>hide:part</opt>
+               </option>
+               <option>
+                       <name>Complex</name>
+                       <key>complex</key>
+                       <opt>type:complex</opt>
+                       <opt>hide:none</opt>
+               </option>
+               <option>
+                       <name>Float</name>
+                       <key>eng_float</key>
+                       <opt>type:real</opt>
+                       <opt>hide:none</opt>
+               </option>
+               <option>
+                       <name>Int</name>
+                       <key>int</key>
+                       <opt>type:int</opt>
+                       <opt>hide:none</opt>
+               </option>
+               <option>
+                       <name>Long</name>
+                       <key>long</key>
+                       <opt>type:int</opt>
+                       <opt>hide:none</opt>
+               </option>
+               <option>
+                       <name>String</name>
+                       <key>string</key>
+                       <opt>type:string</opt>
+                       <opt>hide:none</opt>
+               </option>
+       </param>
+       <doc>
+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.
+
+The paramater value cannot depend on any variables.
+
+Leave the label blank to use the parameter id as the label. \
+The label only applies when this flow graph is instantiated as a hierarchical block.
+
+When type is not None, this parameter also becomes a command line option of the form --[id] [value].
+       </doc>
+</block>