-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSensorModes.html
More file actions
384 lines (384 loc) · 15.3 KB
/
SensorModes.html
File metadata and controls
384 lines (384 loc) · 15.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="es">
<head>
<!-- Generated by javadoc (1.8.0_05) on Sat Feb 06 19:10:42 CET 2016 -->
<title>SensorModes</title>
<meta name="date" content="2016-02-06">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SensorModes";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ev3dev/hardware/sensor/SensorModes.html" target="_top">Frames</a></li>
<li><a href="SensorModes.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ev3dev.hardware.sensor</div>
<h2 title="Interface SensorModes" class="title">Interface SensorModes</h2>
<map id="G" name="G">
<area shape="rect" id="node1_0" href="./BaseSensor.html" title="ev3dev.hardware.sensor.BaseSensor" alt="" coords="16,406,344,815"/>
<area shape="rect" id="node1" href="./BaseSensor.html" title="<TABLE>" alt="" coords="5,401,355,821"/>
<area shape="rect" id="node2_1" href="./SensorMode.html" title="ev3dev.hardware.sensor.SensorMode" alt="" coords="111,11,249,101"/>
<area shape="rect" id="node2" href="./SensorMode.html" title="<TABLE>" alt="" coords="100,6,260,106"/>
<area shape="rect" id="node3_2" href="./SensorModes.html" title="ev3dev.hardware.sensor.SensorModes" alt="" coords="34,161,326,346"/>
<area shape="rect" id="node3" href="./SensorModes.html" title="<TABLE>" alt="" coords="23,155,337,351"/>
</map>
<!-- UML diagram added by UMLGraph version R5_6-24-gf6e263 (http://www.umlgraph.org/) -->
<div align="center"><img src="SensorModes.png" alt="Package class diagram package SensorModes" usemap="#G" border=0/></div>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../lejos/robotics/SampleProvider.html" title="interface in lejos.robotics">SampleProvider</a>, <a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor">SensorMode</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../ev3dev/hardware/sensor/BaseSensor.html" title="class in ev3dev.hardware.sensor">BaseSensor</a>, <a href="../../../ev3dev/hardware/sensor/ev3/EV3ColorSensor.html" title="class in ev3dev.hardware.sensor.ev3">EV3ColorSensor</a>, <a href="../../../ev3dev/hardware/sensor/ev3/EV3GyroSensor.html" title="class in ev3dev.hardware.sensor.ev3">EV3GyroSensor</a>, <a href="../../../ev3dev/hardware/sensor/ev3/EV3IRSensor.html" title="class in ev3dev.hardware.sensor.ev3">EV3IRSensor</a>, <a href="../../../ev3dev/hardware/sensor/ev3/EV3TouchSensor.html" title="class in ev3dev.hardware.sensor.ev3">EV3TouchSensor</a>, <a href="../../../ev3dev/hardware/sensor/ev3/EV3UltrasonicSensor.html" title="class in ev3dev.hardware.sensor.ev3">EV3UltrasonicSensor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SensorModes</span>
extends <a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor">SensorMode</a></pre>
<div class="block">Provide access to the modes supported by a sensor</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.ArrayList<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ev3dev/hardware/sensor/SensorModes.html#getAvailableModes--">getAvailableModes</a></span>()</code>
<div class="block">Return a list of string descriptions for the sensors available modes.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ev3dev/hardware/sensor/SensorModes.html#getCurrentMode--">getCurrentMode</a></span>()</code>
<div class="block">Gets the index number of the current mode.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor">SensorMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ev3dev/hardware/sensor/SensorModes.html#getMode-int-">getMode</a></span>(int mode)</code>
<div class="block">Return the sample provider interface for the requested mode</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor">SensorMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ev3dev/hardware/sensor/SensorModes.html#getMode-java.lang.String-">getMode</a></span>(java.lang.String modeName)</code>
<div class="block">Return the sample provider for the request mode</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ev3dev/hardware/sensor/SensorModes.html#getModeCount--">getModeCount</a></span>()</code>
<div class="block">Gets the number of supported modes</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ev3dev/hardware/sensor/SensorModes.html#setCurrentMode-int-">setCurrentMode</a></span>(int mode)</code>
<div class="block">Sets the current mode for fetching samples</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ev3dev/hardware/sensor/SensorModes.html#setCurrentMode-java.lang.String-">setCurrentMode</a></span>(java.lang.String modeName)</code>
<div class="block">Sets the current mode for fetching samples</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.ev3dev.hardware.sensor.SensorMode">
<!-- -->
</a>
<h3>Methods inherited from interface ev3dev.hardware.sensor.<a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor">SensorMode</a></h3>
<code><a href="../../../ev3dev/hardware/sensor/SensorMode.html#getName--">getName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.lejos.robotics.SampleProvider">
<!-- -->
</a>
<h3>Methods inherited from interface lejos.robotics.<a href="../../../lejos/robotics/SampleProvider.html" title="interface in lejos.robotics">SampleProvider</a></h3>
<code><a href="../../../lejos/robotics/SampleProvider.html#fetchSample-float:A-int-">fetchSample</a>, <a href="../../../lejos/robotics/SampleProvider.html#sampleSize--">sampleSize</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAvailableModes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailableModes</h4>
<pre>java.util.ArrayList<java.lang.String> getAvailableModes()</pre>
<div class="block">Return a list of string descriptions for the sensors available modes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of string descriptions</dd>
</dl>
</li>
</ul>
<a name="getMode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMode</h4>
<pre><a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor">SensorMode</a> getMode(int mode)</pre>
<div class="block">Return the sample provider interface for the requested mode</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mode</code> - the mode number</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sample provider for this mode</dd>
</dl>
</li>
</ul>
<a name="getMode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMode</h4>
<pre><a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor">SensorMode</a> getMode(java.lang.String modeName)</pre>
<div class="block">Return the sample provider for the request mode</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>modeName</code> - the name/description of the mode</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sample provider for the requested mode.</dd>
</dl>
</li>
</ul>
<a name="setCurrentMode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCurrentMode</h4>
<pre>void setCurrentMode(int mode)</pre>
<div class="block">Sets the current mode for fetching samples</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mode</code> - the index number of the mode. Index number corresponds with the item order of the list from getAvailableModes().</dd>
</dl>
</li>
</ul>
<a name="setCurrentMode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCurrentMode</h4>
<pre>void setCurrentMode(java.lang.String modeName)</pre>
<div class="block">Sets the current mode for fetching samples</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>modeName</code> - the name of the mode. name corresponds with the item value of the list from getAvailableModes().</dd>
</dl>
</li>
</ul>
<a name="getCurrentMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentMode</h4>
<pre>int getCurrentMode()</pre>
<div class="block">Gets the index number of the current mode.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the index number of the mode. Index number corresponds with the item order of the list from getAvailableModes().</dd>
</dl>
</li>
</ul>
<a name="getModeCount--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getModeCount</h4>
<pre>int getModeCount()</pre>
<div class="block">Gets the number of supported modes</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of supported modes</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../ev3dev/hardware/sensor/SensorMode.html" title="interface in ev3dev.hardware.sensor"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ev3dev/hardware/sensor/SensorModes.html" target="_top">Frames</a></li>
<li><a href="SensorModes.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>