Imported Upstream version 3.2.2
[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..5d08c4b
--- /dev/null
@@ -0,0 +1,92 @@
+<?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>#if $type() then 'none' else 'part'#</hide>
+               <option>
+                       <name>None</name>
+                       <key></key>
+                       <opt>type:raw</opt>
+               </option>
+               <option>
+                       <name>Complex</name>
+                       <key>complex</key>
+                       <opt>type:complex</opt>
+               </option>
+               <option>
+                       <name>Float</name>
+                       <key>eng_float</key>
+                       <opt>type:real</opt>
+               </option>
+               <option>
+                       <name>Int</name>
+                       <key>int</key>
+                       <opt>type:int</opt>
+               </option>
+               <option>
+                       <name>Long</name>
+                       <key>long</key>
+                       <opt>type:int</opt>
+               </option>
+               <option>
+                       <name>String</name>
+                       <key>string</key>
+                       <opt>type:string</opt>
+               </option>
+       </param>
+       <param>
+               <name>Short ID</name>
+               <key>short_id</key>
+               <value></value>
+               <type>string</type>
+               <hide>#if not $type()
+all#slurp
+#elif $short_id()
+none#slurp
+#else
+part#slurp
+#end if</hide>
+       </param>
+       <check>len($short_id) in (0, 1)</check>
+       <check>$short_id == '' or $(short_id).isalpha()</check>
+       <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.
+
+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.
+       </doc>
+</block>