ef037737396bc3cf804a2f61ab85bee0f2c726a7
[debian/gnuradio] / grc / blocks / wxgui_scopesink2.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##Scope Sink
5 ###################################################
6  -->
7 <block>
8         <name>Scope Sink</name>
9         <key>wxgui_scopesink2</key>
10         <import>from gnuradio.wxgui import scopesink2</import>
11         <import>from gnuradio import gr</import>
12         <make>#set $parent = $notebook() and 'self.%s.GetPage(%s)'%$notebook() or 'self'
13 scopesink2.$(type.fcn)(
14         $(parent).GetWin(),
15         title=$title,
16         sample_rate=$samp_rate,
17         v_scale=$v_scale,
18         v_offset=$v_offset,
19         t_scale=$t_scale,
20         ac_couple=$ac_couple,
21         xy_mode=$xy_mode,
22         num_inputs=$num_inputs,
23         trig_mode=$trig_mode,
24         y_axis_label=$y_axis_label,
25 #if $win_size()
26         size=$win_size,
27 #end if
28 )
29 #if not $grid_pos()
30 $(parent).Add(self.$(id).win)
31 #else
32 $(parent).GridAdd(self.$(id).win, $(', '.join(map(str, $grid_pos()))))
33 #end if</make>
34         <callback>set_sample_rate($samp_rate)</callback>
35         <param>
36                 <name>Type</name>
37                 <key>type</key>
38                 <value>complex</value>
39                 <type>enum</type>
40                 <option>
41                         <name>Complex</name>
42                         <key>complex</key>
43                         <opt>fcn:scope_sink_c</opt>
44                 </option>
45                 <option>
46                         <name>Float</name>
47                         <key>float</key>
48                         <opt>fcn:scope_sink_f</opt>
49                 </option>
50         </param>
51         <param>
52                 <name>Title</name>
53                 <key>title</key>
54                 <value>Scope Plot</value>
55                 <type>string</type>
56         </param>
57         <param>
58                 <name>Sample Rate</name>
59                 <key>samp_rate</key>
60                 <value>samp_rate</value>
61                 <type>real</type>
62         </param>
63         <param>
64                 <name>V Scale</name>
65                 <key>v_scale</key>
66                 <value>0</value>
67                 <type>real</type>
68                 <hide>#if $v_scale() then 'none' else 'part'#</hide>
69         </param>
70         <param>
71                 <name>V Offset</name>
72                 <key>v_offset</key>
73                 <value>0</value>
74                 <type>real</type>
75                 <hide>#if $v_offset() then 'none' else 'part'#</hide>
76         </param>
77         <param>
78                 <name>T Scale</name>
79                 <key>t_scale</key>
80                 <value>0</value>
81                 <type>real</type>
82                 <hide>#if $t_scale() then 'none' else 'part'#</hide>
83         </param>
84         <param>
85                 <name>AC Couple</name>
86                 <key>ac_couple</key>
87                 <value>False</value>
88                 <type>bool</type>
89                 <hide>#if $ac_couple() then 'none' else 'part'#</hide>
90                 <option>
91                         <name>Off</name>
92                         <key>False</key>
93                 </option>
94                 <option>
95                         <name>On</name>
96                         <key>True</key>
97                 </option>
98         </param>
99         <param>
100                 <name>XY Mode</name>
101                 <key>xy_mode</key>
102                 <value>False</value>
103                 <type>enum</type>
104                 <hide>#if $xy_mode() == 'True' then 'none' else 'part'#</hide>
105                 <option>
106                         <name>Off</name>
107                         <key>False</key>
108                 </option>
109                 <option>
110                         <name>On</name>
111                         <key>True</key>
112                 </option>
113         </param>
114         <param>
115                 <name>Num Inputs</name>
116                 <key>num_inputs</key>
117                 <value>1</value>
118                 <type>int</type>
119         </param>
120         <param>
121                 <name>Window Size</name>
122                 <key>win_size</key>
123                 <value></value>
124                 <type>int_vector</type>
125                 <hide>#if $win_size() then 'none' else 'part'#</hide>
126         </param>
127         <param>
128                 <name>Grid Position</name>
129                 <key>grid_pos</key>
130                 <value></value>
131                 <type>grid_pos</type>
132         </param>
133         <param>
134                 <name>Notebook</name>
135                 <key>notebook</key>
136                 <value></value>
137                 <type>notebook</type>
138         </param>
139         <param>
140                 <name>Trigger Mode</name>
141                 <key>trig_mode</key>
142                 <type>enum</type>
143                 <option>
144                         <name>Auto</name>
145                         <key>gr.gr_TRIG_MODE_AUTO</key>
146                 </option>
147                 <option>
148                         <name>Normal</name>
149                         <key>gr.gr_TRIG_MODE_NORM</key>
150                 </option>
151                 <option>
152                         <name>Freerun</name>
153                         <key>gr.gr_TRIG_MODE_FREE</key>
154                 </option>
155                 <option>
156                         <name>Stripchart</name>
157                         <key>gr.gr_TRIG_MODE_STRIPCHART</key>
158                 </option>
159         </param>
160         <param>
161                 <name>Y Axis Label</name>
162                 <key>y_axis_label</key>
163                 <value>Counts</value>
164                 <type>string</type>
165         </param>
166         <check>not $win_size or len($win_size) == 2</check>
167         <check>not $xy_mode or '$type' == 'complex' or $num_inputs != 1</check>
168         <sink>
169                 <name>in</name>
170                 <type>$type</type>
171                 <nports>$num_inputs</nports>
172         </sink>
173         <doc>
174 Set the V Scale to 0 for the scope to auto-scale.
175
176 Set the T Scale to 0 for automatic setting.
177
178 XY Mode allows the scope to initialize as an XY plotter.
179
180 Leave the window blank for the default size, otherwise enter a tuple of (width, height) pixels.
181
182 Use the Grid Position (row, column, row span, column span) to position the graphical element in the window.
183
184 Use the Notebook Param (notebook-id, page-index) to place the graphical element inside of a notebook page.
185         </doc>
186 </block>