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