git.gag.com Git - debian/gnuradio/blob - grc/data/platforms/python/blocks/parameter.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 ###################################################
   4 ##Parameter block: a grc variable with key, value
   5 ###################################################
   6  -->
   7 <block>
   8         <name>Parameter</name>
   9         <key>parameter</key>
  10         <make>$value</make>
  11         <param>
  12                 <name>Label</name>
  13                 <key>label</key>
  14                 <value></value>
  15                 <type>string</type>
  16                 <hide>#if $label() then 'none' else 'part'#</hide>
  17         </param>
  18         <param>
  19                 <name>Value</name>
  20                 <key>value</key>
  21                 <value>0</value>
  22                 <type>$type.type</type>
  23         </param>
  24         <param>
  25                 <name>Type</name>
  26                 <key>type</key>
  27                 <value></value>
  28                 <type>enum</type>
  29                 <hide>$type.hide</hide>
  30                 <option>
  31                         <name>None</name>
  32                         <key></key>
  33                         <opt>type:raw</opt>
  34                         <opt>hide:part</opt>
  35                 </option>
  36                 <option>
  37                         <name>Complex</name>
  38                         <key>complex</key>
  39                         <opt>type:complex</opt>
  40                         <opt>hide:none</opt>
  41                 </option>
  42                 <option>
  43                         <name>Float</name>
  44                         <key>eng_float</key>
  45                         <opt>type:real</opt>
  46                         <opt>hide:none</opt>
  47                 </option>
  48                 <option>
  49                         <name>Int</name>
  50                         <key>int</key>
  51                         <opt>type:int</opt>
  52                         <opt>hide:none</opt>
  53                 </option>
  54                 <option>
  55                         <name>Long</name>
  56                         <key>long</key>
  57                         <opt>type:int</opt>
  58                         <opt>hide:none</opt>
  59                 </option>
  60                 <option>
  61                         <name>String</name>
  62                         <key>string</key>
  63                         <opt>type:string</opt>
  64                         <opt>hide:none</opt>
  65                 </option>
  66         </param>
  67         <doc>
  68 This block represents a parameter to the flow graph. \
  69 A parameter can be used to pass command line arguments into a top block. \
  70 Or, parameters can pass arguments into an instantiated hierarchical block.
  71
  72 The paramater value cannot depend on any variables.
  73
  74 Leave the label blank to use the parameter id as the label. \
  75 The label only applies when this flow graph is instantiated as a hierarchical block.
  76
  77 When type is not None, this parameter also becomes a command line option of the form --[id] [value].
  78         </doc>
  79 </block>