git.gag.com Git - debian/gnuradio/blob - grc/blocks/options.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 ###################################################
   4 ##Options Block:
   5 ## options for window size,
   6 ## and flow graph building.
   7 ###################################################
   8  -->
   9 <block>
  10         <name>Options</name>
  11         <key>options</key>
  12         <import>from gnuradio import gr</import>
  13         <import>from gnuradio.gr import firdes</import>
  14         <import>#if $generate_options() == 'wx_gui'
  15 from grc_gnuradio import wxgui as grc_wxgui
  16 import wx
  17 #end if
  18 #if $generate_options() != 'hb'
  19 from optparse import OptionParser
  20 from gnuradio.eng_option import eng_option
  21 from gnuradio import eng_notation
  22 #end if</import>
  23         <make></make>
  24         <callback>if $run: self.start()
  25 else: self.stop(); self.wait()</callback>
  26         <param>
  27                 <name>Title</name>
  28                 <key>title</key>
  29                 <value></value>
  30                 <type>string</type>
  31                 <hide>#if $title() then 'none' else 'part'#</hide>
  32         </param>
  33         <param>
  34                 <name>Author</name>
  35                 <key>author</key>
  36                 <value></value>
  37                 <type>string</type>
  38                 <hide>#if $author() then 'none' else 'part'#</hide>
  39         </param>
  40         <param>
  41                 <name>Description</name>
  42                 <key>description</key>
  43                 <value></value>
  44                 <type>string</type>
  45                 <hide>#if $description() then 'none' else 'part'#</hide>
  46         </param>
  47         <param>
  48                 <name>Window Size</name>
  49                 <key>window_size</key>
  50                 <value>1280, 1024</value>
  51                 <type>int_vector</type>
  52                 <hide>part</hide>
  53         </param>
  54         <param>
  55                 <name>Generate Options</name>
  56                 <key>generate_options</key>
  57                 <value>wx_gui</value>
  58                 <type>enum</type>
  59                 <hide>#if $generate_options() == 'wx_gui' then 'part' else 'none'#</hide>
  60                 <option>
  61                         <name>WX GUI</name>
  62                         <key>wx_gui</key>
  63                 </option>
  64                 <option>
  65                         <name>No GUI</name>
  66                         <key>no_gui</key>
  67                 </option>
  68                 <option>
  69                         <name>Hier Block</name>
  70                         <key>hb</key>
  71                 </option>
  72         </param>
  73         <param>
  74                 <name>Category</name>
  75                 <key>category</key>
  76                 <value>Custom</value>
  77                 <type>string</type>
  78                 <hide>#if $generate_options() == 'hb' then 'none' else 'all'#</hide>
  79         </param>
  80         <param>
  81                 <name>Run Options</name>
  82                 <key>run_options</key>
  83                 <value>prompt</value>
  84                 <type>enum</type>
  85                 <hide>#if $generate_options() == 'no_gui' then 'none' else 'all'#</hide>
  86                 <option>
  87                         <name>Run to Completion</name>
  88                         <key>run</key>
  89                 </option>
  90                 <option>
  91                         <name>Prompt for Exit</name>
  92                         <key>prompt</key>
  93                 </option>
  94         </param>
  95         <param>
  96                 <name>Run</name>
  97                 <key>run</key>
  98                 <value>True</value>
  99                 <type>bool</type>
 100                 <hide>
 101 #if $generate_options() == 'wx_gui'
 102         #if $run()
 103                 part
 104         #else
 105                 none
 106         #end if
 107 #else
 108         all
 109 #end if
 110                 </hide>
 111                 <option>
 112                         <name>Autostart</name>
 113                         <key>True</key>
 114                 </option>
 115                 <option>
 116                         <name>Off</name>
 117                         <key>False</key>
 118                 </option>
 119         </param>
 120         <param>
 121                 <name>Realtime Scheduling</name>
 122                 <key>realtime_scheduling</key>
 123                 <value></value>
 124                 <type>enum</type>
 125                 <hide>#if $generate_options() == 'hb'
 126 all#slurp
 127 #elif $realtime_scheduling()
 128 none#slurp
 129 #else
 130 part#slurp
 131 #end if</hide>
 132                 <option>
 133                         <name>Off</name>
 134                         <key></key>
 135                 </option>
 136                 <option>
 137                         <name>On</name>
 138                         <key>1</key>
 139                 </option>
 140         </param>
 141         <check>len($window_size) == 2</check>
 142         <check>300 &lt;= $(window_size)[0] &lt;= 4096</check>
 143         <check>300 &lt;= $(window_size)[1] &lt;= 4096</check>
 144         <doc>
 145 The options block sets special parameters for the flow graph. \
 146 Only one option block is allowed per flow graph.
 147
 148 Title, author, and description parameters are for identification purposes.
 149
 150 The window size controls the dimensions of the flow graph editor. \
 151 The window size (width, height) must be between (300, 300) and (4096, 4096).
 152
 153 The generate options controls the type of code generated. \
 154 Non-graphical flow graphs should avoid using graphical sinks or graphical variable controls.
 155
 156 In a graphical application, \
 157 run can be controlled by a variable to start and stop the flowgraph at runtime.
 158
 159 The id of this block determines the name of the generated file and the name of the class. \
 160 For example, an id of my_block will generate the file my_block.py and class my_block(gr....
 161
 162 The category parameter determines the placement of the block in the block selection window. \
 163 The category only applies when creating hier blocks. \
 164 To put hier blocks into the root category, enter / for the category.
 165         </doc>
 166 </block>