git.gag.com Git - debian/gnuradio/blob - grc/data/platforms/python/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
  13 #if $generate_options() == 'wx_gui'
  14 from grc_gnuradio import wxgui as grc_wxgui
  15 import wx
  16 #end if
  17 #if $generate_options() != 'hb'
  18 from optparse import OptionParser
  19 from gnuradio.eng_option import eng_option
  20 #end if
  21 </import>
  22         <make></make>
  23         <param>
  24                 <name>Title</name>
  25                 <key>title</key>
  26                 <value>untitled</value>
  27                 <type>string</type>
  28         </param>
  29         <param>
  30                 <name>Author</name>
  31                 <key>author</key>
  32                 <value>unknown</value>
  33                 <type>string</type>
  34         </param>
  35         <param>
  36                 <name>Description</name>
  37                 <key>description</key>
  38                 <value>gnuradio flow graph</value>
  39                 <type>string</type>
  40         </param>
  41         <param>
  42                 <name>Window Size</name>
  43                 <key>window_size</key>
  44                 <value>1280, 1024</value>
  45                 <type>int_vector</type>
  46                 <hide>part</hide>
  47         </param>
  48         <param>
  49                 <name>Generate Options</name>
  50                 <key>generate_options</key>
  51                 <value>wx_gui</value>
  52                 <type>enum</type>
  53                 <option>
  54                         <name>WX GUI</name>
  55                         <key>wx_gui</key>
  56                 </option>
  57                 <option>
  58                         <name>No GUI</name>
  59                         <key>no_gui</key>
  60                 </option>
  61                 <option>
  62                         <name>Hier Block</name>
  63                         <key>hb</key>
  64                 </option>
  65         </param>
  66         <param>
  67                 <name>Category</name>
  68                 <key>category</key>
  69                 <value>Custom</value>
  70                 <type>string</type>
  71                 <hide>#if $generate_options() == 'hb' then 'none' else 'all'#</hide>
  72         </param>
  73         <param>
  74                 <name>Realtime Scheduling</name>
  75                 <key>realtime_scheduling</key>
  76                 <value></value>
  77                 <type>enum</type>
  78                 <hide>#if $generate_options() == 'hb'
  79 all#slurp
  80 #elif $realtime_scheduling()
  81 none#slurp
  82 #else
  83 part#slurp
  84 #end if</hide>
  85                 <option>
  86                         <name>Off</name>
  87                         <key></key>
  88                 </option>
  89                 <option>
  90                         <name>On</name>
  91                         <key>1</key>
  92                 </option>
  93         </param>
  94         <check>len($window_size) == 2</check>
  95         <check>300 &lt;= $(window_size)[0] &lt;= 4096</check>
  96         <check>300 &lt;= $(window_size)[1] &lt;= 4096</check>
  97         <doc>
  98 The options block sets special parameters for the flow graph. \
  99 Only one option block is allowed per flow graph.
 100
 101 Title, author, and description parameters are for identification purposes.
 102
 103 The window size controls the dimensions of the flow graph editor. \
 104 The window size (width, height) must be between (300, 300) and (4096, 4096).
 105
 106 The generate options controls the type of code generated. \
 107 Non-graphical flow graphs should avoid using graphical sinks or graphical variable controls.
 108
 109 The id of this block determines the name of the generated file and the name of the class. \
 110 For example, an id of my_block will generate the file my_block.py and class my_block(gr....
 111
 112 The category parameter determines the placement of the block in the block selection window. \
 113 The category only applies when creating hier blocks. \
 114 To put hier blocks into the root category, enter / for the category.
 115         </doc>
 116 </block>