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