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