summaryrefslogtreecommitdiff
path: root/grc/data/grc_gnuradio/blocks/options.xml
blob: 8e8f0689177ad83c63d45c84e4957a169f26952c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<?xml version="1.0"?>
<!--
###################################################
##Options Block:
## options for window size,
## and flow graph building.
###################################################
 -->
<block>
	<name>Options</name>
	<key>options</key>
	<import>from gnuradio import gr
#if $generate_options.eval == 'wx_gui'
from grc_gnuradio import wxgui as grc_wxgui
import wx
#end if
</import>
	<make></make>
	<param>
		<name>Title</name>
		<key>title</key>
		<value>untitled</value>
		<type>string</type>
	</param>
	<param>
		<name>Author</name>
		<key>author</key>
		<value>unknown</value>
		<type>string</type>
	</param>
	<param>
		<name>Description</name>
		<key>description</key>
		<value>gnuradio flow graph</value>
		<type>string</type>
	</param>
	<param>
		<name>Window Size</name>
		<key>window_size</key>
		<value>1280, 1024</value>
		<type>int_vector</type>
	</param>
	<param>
		<name>Generate Options</name>
		<key>generate_options</key>
		<value>wx_gui</value>
		<type>enum</type>
		<option>
			<name>WX GUI</name>
			<key>wx_gui</key>
			<opt>hide_category:all</opt>
		</option>
		<option>
			<name>No GUI</name>
			<key>no_gui</key>
			<opt>hide_category:all</opt>
		</option>
		<option>
			<name>Hier Block</name>
			<key>hb</key>
			<opt>hide_category:</opt>
		</option>
	</param>
	<param>
		<name>Category</name>
		<key>category</key>
		<value>Custom</value>
		<type>string</type>
		<hide>$generate_options.hide_category</hide>
	</param>
	<check>len($window_size) == 2</check>
	<check>300 &lt;= $(window_size)[0] &lt;= 2048</check>
	<check>300 &lt;= $(window_size)[1] &lt;= 2048</check>
	<doc>
The options block sets special parameters for the flow graph. \
Only one option block is allowed per flow graph.

Title, author, and description parameters are for identification purposes.

The window size controls the dimensions of the flow graph editor. \
The window size (width, height) must be between (300, 300) and (2048, 2048).

The generate options controls the type of code generated. \
Non-graphical flow graphs should avoid using graphical sinks or graphical variable controls.

The id of this block determines the name of the generated file and the name of the class. \
For example, an id of my_block will generate the file my_block.py and class my_block(gr....

The category parameter determines the placement of the block in the block selection window. \
The category only applies when creating hier blocks. \
To put hier blocks into the root category, enter / for the category.
	</doc>
</block>