Merge remote branch 'ets/grc-usrp2-clock-source'
[debian/gnuradio] / grc / blocks / wxgui_numbersink2.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##Number Sink
5 ###################################################
6  -->
7 <block>
8         <name>Number Sink</name>
9         <key>wxgui_numbersink2</key>
10         <import>from gnuradio.wxgui import numbersink2</import>
11         <make>#set $parent = $notebook() and 'self.%s.GetPage(%s)'%$notebook() or 'self'
12 numbersink2.$(type.fcn)(
13         $(parent).GetWin(),
14         unit=$units,
15         minval=$min_value,
16         maxval=$max_value,
17         factor=$factor,
18         decimal_places=$decimal_places,
19         ref_level=$ref_level,
20         sample_rate=$samp_rate,
21         number_rate=$number_rate,
22         average=$average,
23         avg_alpha=#if $avg_alpha() then $avg_alpha else 'None'#,
24         label=$title,
25         peak_hold=$peak_hold,
26         show_gauge=$show_gauge,
27 #if $win_size()
28         size=$win_size,
29 #end if
30 )
31 #if not $grid_pos()
32 $(parent).Add(self.$(id).win)
33 #else
34 $(parent).GridAdd(self.$(id).win, $(', '.join(map(str, $grid_pos()))))
35 #end if</make>
36         <param>
37                 <name>Type</name>
38                 <key>type</key>
39                 <value>complex</value>
40                 <type>enum</type>
41                 <option>
42                         <name>Complex</name>
43                         <key>complex</key>
44                         <opt>fcn:number_sink_c</opt>
45                 </option>
46                 <option>
47                         <name>Float</name>
48                         <key>float</key>
49                         <opt>fcn:number_sink_f</opt>
50                 </option>
51         </param>
52         <param>
53                 <name>Title</name>
54                 <key>title</key>
55                 <value>Number Plot</value>
56                 <type>string</type>
57         </param>
58         <param>
59                 <name>Units</name>
60                 <key>units</key>
61                 <value>Units</value>
62                 <type>string</type>
63         </param>
64         <param>
65                 <name>Sample Rate</name>
66                 <key>samp_rate</key>
67                 <value>samp_rate</value>
68                 <type>real</type>
69         </param>
70         <param>
71                 <name>Min Value</name>
72                 <key>min_value</key>
73                 <value>-100</value>
74                 <type>real</type>
75         </param>
76         <param>
77                 <name>Max Value</name>
78                 <key>max_value</key>
79                 <value>100</value>
80                 <type>real</type>
81         </param>
82         <param>
83                 <name>Factor</name>
84                 <key>factor</key>
85                 <value>1.0</value>
86                 <type>real</type>
87         </param>
88         <param>
89                 <name>Decimal Places</name>
90                 <key>decimal_places</key>
91                 <value>10</value>
92                 <type>int</type>
93         </param>
94         <param>
95                 <name>Reference Level</name>
96                 <key>ref_level</key>
97                 <value>0</value>
98                 <type>real</type>
99         </param>
100         <param>
101                 <name>Number Rate</name>
102                 <key>number_rate</key>
103                 <value>15</value>
104                 <type>int</type>
105         </param>
106         <param>
107                 <name>Peak Hold</name>
108                 <key>peak_hold</key>
109                 <value>False</value>
110                 <type>enum</type>
111                 <hide>#if $peak_hold() == 'True' then 'none' else 'part'#</hide>
112                 <option>
113                         <name>On</name>
114                         <key>True</key>
115                 </option>
116                 <option>
117                         <name>Off</name>
118                         <key>False</key>
119                 </option>
120         </param>
121         <param>
122                 <name>Average</name>
123                 <key>average</key>
124                 <value>False</value>
125                 <type>enum</type>
126                 <hide>part</hide>
127                 <option>
128                         <name>On</name>
129                         <key>True</key>
130                 </option>
131                 <option>
132                         <name>Off</name>
133                         <key>False</key>
134                 </option>
135         </param>
136         <param>
137                 <name>Average Alpha</name>
138                 <key>avg_alpha</key>
139                 <value>0</value>
140                 <type>real</type>
141                 <hide>#if $average() == 'True' then 'none' else 'all'#</hide>
142         </param>
143         <param>
144                 <name>Show Gauge</name>
145                 <key>show_gauge</key>
146                 <value>True</value>
147                 <type>enum</type>
148                 <option>
149                         <name>Show</name>
150                         <key>True</key>
151                 </option>
152                 <option>
153                         <name>Hide</name>
154                         <key>False</key>
155                 </option>
156         </param>
157         <param>
158                 <name>Window Size</name>
159                 <key>win_size</key>
160                 <value></value>
161                 <type>int_vector</type>
162                 <hide>#if $win_size() then 'none' else 'part'#</hide>
163         </param>
164         <param>
165                 <name>Grid Position</name>
166                 <key>grid_pos</key>
167                 <value></value>
168                 <type>grid_pos</type>
169         </param>
170         <param>
171                 <name>Notebook</name>
172                 <key>notebook</key>
173                 <value></value>
174                 <type>notebook</type>
175         </param>
176         <check>not $win_size or len($win_size) == 2</check>
177         <sink>
178                 <name>in</name>
179                 <type>$type</type>
180         </sink>
181         <doc>
182 Set Average Alpha to 0 for automatic setting.
183
184 Leave the window blank for the default size, otherwise enter a tuple of (width, height) pixels.
185
186 Use the Grid Position (row, column, row span, column span) to position the graphical element in the window.
187
188 Use the Notebook Param (notebook-id, page-index) to place the graphical element inside of a notebook page.
189
190 Incoming numbers are multiplied by the factor, and then added-to by the reference level.
191         </doc>
192 </block>