Updated javadocs for the new GH pages style.
This commit is contained in:
@@ -0,0 +1,382 @@
|
||||
<!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 (version 1.7.0_75) on Thu Feb 05 15:36:28 VET 2015 -->
|
||||
<title>DecodedControlAction.Action</title>
|
||||
<meta name="date" content="2015-02-05">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="DecodedControlAction.Action";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="topNav"><a name="navbar_top">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Prev Class</span></a></li>
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" target="_top">Frames</a></li>
|
||||
<li><a href="DecodedControlAction.Action.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><a href="#enum_constant_summary">Enum Constants</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#method_summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
|
||||
<li>Field | </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">ve.ucv.ciens.icaro.libnxtarcontrol</div>
|
||||
<h2 title="Enum DecodedControlAction.Action" class="title">Enum DecodedControlAction.Action</h2>
|
||||
</div>
|
||||
<div class="contentContainer">
|
||||
<ul class="inheritance">
|
||||
<li>java.lang.Object</li>
|
||||
<li>
|
||||
<ul class="inheritance">
|
||||
<li>java.lang.Enum<<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a>></li>
|
||||
<li>
|
||||
<ul class="inheritance">
|
||||
<li>ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="description">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<dl>
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a>></dd>
|
||||
</dl>
|
||||
<dl>
|
||||
<dt>Enclosing class:</dt>
|
||||
<dd><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<br>
|
||||
<pre>public static enum <span class="strong">DecodedControlAction.Action</span>
|
||||
extends java.lang.Enum<<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a>></pre>
|
||||
<div class="block"><p>All recognized actions.</p></div>
|
||||
<dl><dt><span class="strong">Since:</span></dt>
|
||||
<dd>December 16, 2014</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="summary">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="enum_constant_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Enum Constant Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
|
||||
<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colOne" scope="col">Enum Constant and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#MOVE_BACKWARDS">MOVE_BACKWARDS</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#MOVE_FORWARD">MOVE_FORWARD</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#RECENTER">RECENTER</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#STOP">STOP</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_1">USER_1</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_2">USER_2</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_3">USER_3</a></strong></code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="method_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Method Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||||
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||||
<th class="colLast" scope="col">Method and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>static <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a></code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code>
|
||||
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>static <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a>[]</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#values()">values</a></strong>()</code>
|
||||
<div class="block">Returns an array containing the constants of this enum type, in
|
||||
the order they are declared.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Methods inherited from class java.lang.Enum</h3>
|
||||
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
|
||||
</ul>
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Methods inherited from class java.lang.Object</h3>
|
||||
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="details">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<!-- ============ ENUM CONSTANT DETAIL =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="enum_constant_detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Enum Constant Detail</h3>
|
||||
<a name="MOVE_FORWARD">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>MOVE_FORWARD</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> MOVE_FORWARD</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="MOVE_BACKWARDS">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>MOVE_BACKWARDS</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> MOVE_BACKWARDS</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="STOP">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>STOP</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> STOP</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="RECENTER">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>RECENTER</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> RECENTER</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="USER_1">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>USER_1</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> USER_1</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="USER_2">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>USER_2</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> USER_2</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="USER_3">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>USER_3</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> USER_3</pre>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="method_detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Method Detail</h3>
|
||||
<a name="values()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>values</h4>
|
||||
<pre>public static <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a>[] values()</pre>
|
||||
<div class="block">Returns an array containing the constants of this enum type, in
|
||||
the order they are declared. This method may be used to iterate
|
||||
over the constants as follows:
|
||||
<pre>
|
||||
for (DecodedControlAction.Action c : DecodedControlAction.Action.values())
|
||||
System.out.println(c);
|
||||
</pre></div>
|
||||
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="valueOf(java.lang.String)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>valueOf</h4>
|
||||
<pre>public static <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> valueOf(java.lang.String name)</pre>
|
||||
<div class="block">Returns the enum constant of this type with the specified name.
|
||||
The string must match <i>exactly</i> an identifier used to declare an
|
||||
enum constant in this type. (Extraneous whitespace characters are
|
||||
not permitted.)</div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
|
||||
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
|
||||
<dd><code>java.lang.NullPointerException</code> - if the argument is null</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Prev Class</span></a></li>
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" target="_top">Frames</a></li>
|
||||
<li><a href="DecodedControlAction.Action.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><a href="#enum_constant_summary">Enum Constants</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#method_summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#method_detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="skip-navbar_bottom">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,382 @@
|
||||
<!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 (version 1.7.0_75) on Thu Feb 05 15:36:28 VET 2015 -->
|
||||
<title>DecodedControlAction.Motor</title>
|
||||
<meta name="date" content="2015-02-05">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="DecodedControlAction.Motor";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="topNav"><a name="navbar_top">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Prev Class</span></a></li>
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" target="_top">Frames</a></li>
|
||||
<li><a href="DecodedControlAction.Motor.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><a href="#enum_constant_summary">Enum Constants</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#method_summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
|
||||
<li>Field | </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">ve.ucv.ciens.icaro.libnxtarcontrol</div>
|
||||
<h2 title="Enum DecodedControlAction.Motor" class="title">Enum DecodedControlAction.Motor</h2>
|
||||
</div>
|
||||
<div class="contentContainer">
|
||||
<ul class="inheritance">
|
||||
<li>java.lang.Object</li>
|
||||
<li>
|
||||
<ul class="inheritance">
|
||||
<li>java.lang.Enum<<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a>></li>
|
||||
<li>
|
||||
<ul class="inheritance">
|
||||
<li>ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="description">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<dl>
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a>></dd>
|
||||
</dl>
|
||||
<dl>
|
||||
<dt>Enclosing class:</dt>
|
||||
<dd><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<br>
|
||||
<pre>public static enum <span class="strong">DecodedControlAction.Motor</span>
|
||||
extends java.lang.Enum<<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a>></pre>
|
||||
<div class="block"><p>All motor ports and possible combinations without repetitions.<p></div>
|
||||
<dl><dt><span class="strong">Since:</span></dt>
|
||||
<dd>December 16, 2014</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="summary">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="enum_constant_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Enum Constant Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
|
||||
<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colOne" scope="col">Enum Constant and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#MOTOR_A">MOTOR_A</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#MOTOR_AB">MOTOR_AB</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#MOTOR_ABC">MOTOR_ABC</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#MOTOR_AC">MOTOR_AC</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#MOTOR_B">MOTOR_B</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#MOTOR_BC">MOTOR_BC</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#MOTOR_C">MOTOR_C</a></strong></code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="method_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Method Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||||
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||||
<th class="colLast" scope="col">Method and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>static <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a></code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code>
|
||||
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>static <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a>[]</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html#values()">values</a></strong>()</code>
|
||||
<div class="block">Returns an array containing the constants of this enum type, in
|
||||
the order they are declared.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Methods inherited from class java.lang.Enum</h3>
|
||||
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
|
||||
</ul>
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Methods inherited from class java.lang.Object</h3>
|
||||
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="details">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<!-- ============ ENUM CONSTANT DETAIL =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="enum_constant_detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Enum Constant Detail</h3>
|
||||
<a name="MOTOR_A">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>MOTOR_A</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> MOTOR_A</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="MOTOR_B">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>MOTOR_B</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> MOTOR_B</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="MOTOR_C">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>MOTOR_C</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> MOTOR_C</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="MOTOR_AB">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>MOTOR_AB</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> MOTOR_AB</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="MOTOR_AC">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>MOTOR_AC</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> MOTOR_AC</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="MOTOR_BC">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>MOTOR_BC</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> MOTOR_BC</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="MOTOR_ABC">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>MOTOR_ABC</h4>
|
||||
<pre>public static final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> MOTOR_ABC</pre>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="method_detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Method Detail</h3>
|
||||
<a name="values()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>values</h4>
|
||||
<pre>public static <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a>[] values()</pre>
|
||||
<div class="block">Returns an array containing the constants of this enum type, in
|
||||
the order they are declared. This method may be used to iterate
|
||||
over the constants as follows:
|
||||
<pre>
|
||||
for (DecodedControlAction.Motor c : DecodedControlAction.Motor.values())
|
||||
System.out.println(c);
|
||||
</pre></div>
|
||||
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="valueOf(java.lang.String)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>valueOf</h4>
|
||||
<pre>public static <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> valueOf(java.lang.String name)</pre>
|
||||
<div class="block">Returns the enum constant of this type with the specified name.
|
||||
The string must match <i>exactly</i> an identifier used to declare an
|
||||
enum constant in this type. (Extraneous whitespace characters are
|
||||
not permitted.)</div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
|
||||
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
|
||||
<dd><code>java.lang.NullPointerException</code> - if the argument is null</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Prev Class</span></a></li>
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" target="_top">Frames</a></li>
|
||||
<li><a href="DecodedControlAction.Motor.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><a href="#enum_constant_summary">Enum Constants</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#method_summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#method_detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="skip-navbar_bottom">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,380 @@
|
||||
<!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 (version 1.7.0_75) on Thu Feb 05 15:36:28 VET 2015 -->
|
||||
<title>DecodedControlAction</title>
|
||||
<meta name="date" content="2015-02-05">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="DecodedControlAction";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="topNav"><a name="navbar_top">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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>Prev Class</li>
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" target="_top">Frames</a></li>
|
||||
<li><a href="DecodedControlAction.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><a href="#nested_class_summary">Nested</a> | </li>
|
||||
<li><a href="#field_summary">Field</a> | </li>
|
||||
<li><a href="#constructor_summary">Constr</a> | </li>
|
||||
<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#field_detail">Field</a> | </li>
|
||||
<li><a href="#constructor_detail">Constr</a> | </li>
|
||||
<li>Method</li>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="skip-navbar_top">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="subTitle">ve.ucv.ciens.icaro.libnxtarcontrol</div>
|
||||
<h2 title="Class DecodedControlAction" class="title">Class DecodedControlAction</h2>
|
||||
</div>
|
||||
<div class="contentContainer">
|
||||
<ul class="inheritance">
|
||||
<li>java.lang.Object</li>
|
||||
<li>
|
||||
<ul class="inheritance">
|
||||
<li>ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="description">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<hr>
|
||||
<br>
|
||||
<pre>public class <span class="strong">DecodedControlAction</span>
|
||||
extends java.lang.Object</pre>
|
||||
<div class="block"><p>An immutable and pure data class that represents an action decoded from a protocol
|
||||
data message.</p></div>
|
||||
<dl><dt><span class="strong">Since:</span></dt>
|
||||
<dd>December 15, 2014</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="summary">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="nested_class_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Nested Class Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
|
||||
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||||
<th class="colLast" scope="col">Class and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>static class </code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a></strong></code>
|
||||
<div class="block">All recognized actions.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>static class </code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a></strong></code>
|
||||
<div class="block">All motor ports and possible combinations without repetitions.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="field_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Field Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
||||
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||||
<th class="colLast" scope="col">Field and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a></code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html#action">action</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a></code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html#motor">motor</a></strong></code> </td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>int</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html#speed">speed</a></strong></code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="constructor_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Constructor Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
||||
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colOne" scope="col">Constructor and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html#DecodedControlAction()">DecodedControlAction</a></strong>()</code>
|
||||
<div class="block">Create a new ControlAction object using <code>DecodedControlAction#STOP</code> as
|
||||
the default action, <code>DecodedControlAction#MOTOR_ABC</code> as motor flag, and
|
||||
0 as default speed.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html#DecodedControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action)">DecodedControlAction</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> action)</code>
|
||||
<div class="block">Create a new ControlAction object using the specified action.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html#DecodedControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action,%20ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor)">DecodedControlAction</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> action,
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motor)</code>
|
||||
<div class="block">Create a new ControlAction object using the specified action and motor flag.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html#DecodedControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action,%20ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor,%20int)">DecodedControlAction</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> action,
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motor,
|
||||
int speed)</code>
|
||||
<div class="block">Create a new ControlAction object using the specified action, motor flag and speed.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="method_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Method Summary</h3>
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Methods inherited from class java.lang.Object</h3>
|
||||
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="details">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="field_detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Field Detail</h3>
|
||||
<a name="action">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>action</h4>
|
||||
<pre>public final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> action</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="motor">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>motor</h4>
|
||||
<pre>public final <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motor</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="speed">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>speed</h4>
|
||||
<pre>public final int speed</pre>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="constructor_detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Constructor Detail</h3>
|
||||
<a name="DecodedControlAction()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>DecodedControlAction</h4>
|
||||
<pre>public DecodedControlAction()</pre>
|
||||
<div class="block"><p>Create a new ControlAction object using <code>DecodedControlAction#STOP</code> as
|
||||
the default action, <code>DecodedControlAction#MOTOR_ABC</code> as motor flag, and
|
||||
0 as default speed.</p></div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="DecodedControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>DecodedControlAction</h4>
|
||||
<pre>public DecodedControlAction(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> action)</pre>
|
||||
<div class="block"><p>Create a new ControlAction object using the specified action. The motor
|
||||
flag is set to <code>DecodedControlAction#MOTOR_ABC</code> and the speed is set to 100.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - The action flag to set.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="DecodedControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action, ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>DecodedControlAction</h4>
|
||||
<pre>public DecodedControlAction(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> action,
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motor)</pre>
|
||||
<div class="block"><p>Create a new ControlAction object using the specified action and motor flag. The
|
||||
speed is set to 100.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - The action flag to set.</dd><dd><code>motor</code> - The motor flag to set.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="DecodedControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action, ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor, int)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>DecodedControlAction</h4>
|
||||
<pre>public DecodedControlAction(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a> action,
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motor,
|
||||
int speed)</pre>
|
||||
<div class="block"><p>Create a new ControlAction object using the specified action, motor flag and speed.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - The action flag to set.</dd><dd><code>motor</code> - The motor flag to set.</dd><dd><code>speed</code> - The speed to set. Will be clamped to the range [-100, 100].</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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>Prev Class</li>
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" target="_top">Frames</a></li>
|
||||
<li><a href="DecodedControlAction.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><a href="#nested_class_summary">Nested</a> | </li>
|
||||
<li><a href="#field_summary">Field</a> | </li>
|
||||
<li><a href="#constructor_summary">Constr</a> | </li>
|
||||
<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#field_detail">Field</a> | </li>
|
||||
<li><a href="#constructor_detail">Constr</a> | </li>
|
||||
<li>Method</li>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="skip-navbar_bottom">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,508 @@
|
||||
<!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 (version 1.7.0_75) on Thu Feb 05 15:36:28 VET 2015 -->
|
||||
<title>NxtARControlProtocol</title>
|
||||
<meta name="date" content="2015-02-05">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="NxtARControlProtocol";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="topNav"><a name="navbar_top">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Prev Class</span></a></li>
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" target="_top">Frames</a></li>
|
||||
<li><a href="NxtARControlProtocol.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><a href="#constructor_summary">Constr</a> | </li>
|
||||
<li><a href="#method_summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor_detail">Constr</a> | </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">ve.ucv.ciens.icaro.libnxtarcontrol</div>
|
||||
<h2 title="Class NxtARControlProtocol" class="title">Class NxtARControlProtocol</h2>
|
||||
</div>
|
||||
<div class="contentContainer">
|
||||
<ul class="inheritance">
|
||||
<li>java.lang.Object</li>
|
||||
<li>
|
||||
<ul class="inheritance">
|
||||
<li>ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="description">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<hr>
|
||||
<br>
|
||||
<pre>public class <span class="strong">NxtARControlProtocol</span>
|
||||
extends java.lang.Object</pre>
|
||||
<div class="block"><p>A wrapper around the NxtAR robot control protocol for the LejOS operating system.</p></div>
|
||||
<dl><dt><span class="strong">Since:</span></dt>
|
||||
<dd>December 15, 2014</dd>
|
||||
<dt><span class="strong">See Also:</span></dt><dd><a href="http://www.lejos.org">The LejOS operating system.</a>,
|
||||
<a href="https://github.com/sagge-miky/NxtAR-core">NxtAR-core Github repository.</a></dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="summary">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="constructor_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Constructor Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
||||
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colOne" scope="col">Constructor and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#NxtARControlProtocol(java.io.DataInputStream,%20java.io.DataOutputStream)">NxtARControlProtocol</a></strong>(java.io.DataInputStream inputStream,
|
||||
java.io.DataOutputStream outputStream)</code>
|
||||
<div class="block">Create a new ARControl object.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="method_summary">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Method Summary</h3>
|
||||
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||||
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||||
<th class="colLast" scope="col">Method and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a></code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#decodeMessage(byte[])">decodeMessage</a></strong>(byte[] message)</code>
|
||||
<div class="block">Decodes a protocol message encoded as a byte array of two elements as specified
|
||||
in the package definition.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>byte[]</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#encodeControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction)">encodeControlAction</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a> action)</code>
|
||||
<div class="block">Encodes a given <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> into a two byte array.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>boolean</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#executeControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction)">executeControlAction</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a> controlAction)</code>
|
||||
<div class="block">Executes an already decoded <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a>, calling the user operation
|
||||
listeners if needed.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>boolean</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#readAndExecuteMessage()">readAndExecuteMessage</a></strong>()</code>
|
||||
<div class="block">Attempts to read, decode and execute a message, calling the user operation
|
||||
listeners if needed.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>byte[]</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#readRawControlMessage()">readRawControlMessage</a></strong>()</code>
|
||||
<div class="block">Attempts to read a 2-byte message and returns it as is.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#registerUserActionListener(ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener)">registerUserActionListener</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol">UserActionListener</a> listener)</code>
|
||||
<div class="block">Adds an <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol"><code>UserActionListener</code></a> to this object's listeners list calling it's
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onListenerRegistered()"><code>UserActionListener.onListenerRegistered()</code></a> method.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#removeUserActionListener(ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener)">removeUserActionListener</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol">UserActionListener</a> listener)</code>
|
||||
<div class="block">Removes an <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol"><code>UserActionListener</code></a> from this object's listeners list calling it's
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onListenerRemoved()"><code>UserActionListener.onListenerRemoved()</code></a> method.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#setInputStream(java.io.DataInputStream)">setInputStream</a></strong>(java.io.DataInputStream inputStream)</code>
|
||||
<div class="block">Changes the input stream associated with this ARControl to the input stream passed as
|
||||
parameter.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#setOutputStream(java.io.DataOutputStream)">setOutputStream</a></strong>(java.io.DataOutputStream outputStream)</code>
|
||||
<div class="block">Changes the <code>DataOutputStream</code> associated with this ARControl to the output stream passed as
|
||||
parameter.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>boolean</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#writeMessage(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction)">writeMessage</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a> action)</code>
|
||||
<div class="block">Encodes and writes a <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> into the associated <code>DataOutputStream</code> if any.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#writeRawControlMessage(byte[])">writeRawControlMessage</a></strong>(byte[] message)</code>
|
||||
<div class="block">Attempts to write a 2-byte message to the associated <code>DataOutputStream</code> if any.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Methods inherited from class java.lang.Object</h3>
|
||||
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="details">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="constructor_detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Constructor Detail</h3>
|
||||
<a name="NxtARControlProtocol(java.io.DataInputStream, java.io.DataOutputStream)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>NxtARControlProtocol</h4>
|
||||
<pre>public NxtARControlProtocol(java.io.DataInputStream inputStream,
|
||||
java.io.DataOutputStream outputStream)</pre>
|
||||
<div class="block"><p>Create a new ARControl object.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - A <code>DataInputStream</code> used to read protocol messages from. Can be null.</dd><dd><code>outputStream</code> - An <code>DataOutputStream</code> used to write protocol messages to. Can be null.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="method_detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Method Detail</h3>
|
||||
<a name="setOutputStream(java.io.DataOutputStream)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>setOutputStream</h4>
|
||||
<pre>public void setOutputStream(java.io.DataOutputStream outputStream)
|
||||
throws java.io.IOException</pre>
|
||||
<div class="block"><p>Changes the <code>DataOutputStream</code> associated with this ARControl to the output stream passed as
|
||||
parameter. The currently set output stream is flushed and closed before replacing it.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outpuStream</code> - An opened output stream. Can be null.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.io.IOException</code> - If an error happened while closing the previous output stream.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="writeRawControlMessage(byte[])">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>writeRawControlMessage</h4>
|
||||
<pre>public void writeRawControlMessage(byte[] message)
|
||||
throws java.io.IOException,
|
||||
java.lang.IllegalArgumentException</pre>
|
||||
<div class="block"><p>Attempts to write a 2-byte message to the associated <code>DataOutputStream</code> if any.</p>
|
||||
|
||||
<p>Returns immediately if no <code>DataOutputStream</code> has been set with
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#setOutputStream(java.io.DataOutputStream)"><code>setOutputStream(DataOutputStream)</code></a> or if the message is null. If the
|
||||
message is longer than two bytes only the first two bytes are written to the output stream.</p></div>
|
||||
<dl><dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.io.IOException</code> - If writing the message fails. It is the same IOException
|
||||
as thrown by <code>DataOutput.write(byte[], int, int)</code>.</dd>
|
||||
<dd><code>java.lang.IllegalArgumentException</code> - If the message lenght is less than two.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="encodeControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>encodeControlAction</h4>
|
||||
<pre>public byte[] encodeControlAction(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a> action)</pre>
|
||||
<div class="block"><p>Encodes a given <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> into a two byte array.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - the action to encode.</dd>
|
||||
<dt><span class="strong">Returns:</span></dt><dd>The encoded action. Null if said action is null.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="writeMessage(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>writeMessage</h4>
|
||||
<pre>public boolean writeMessage(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a> action)
|
||||
throws java.io.IOException</pre>
|
||||
<div class="block"><p>Encodes and writes a <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> into the associated <code>DataOutputStream</code> if any.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - The action to write.</dd>
|
||||
<dt><span class="strong">Returns:</span></dt><dd>True if writing the action succeded. False if either the action or the DataOutputStream are null.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.io.IOException</code> - If writing the message fails.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="setInputStream(java.io.DataInputStream)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>setInputStream</h4>
|
||||
<pre>public void setInputStream(java.io.DataInputStream inputStream)
|
||||
throws java.io.IOException</pre>
|
||||
<div class="block"><p>Changes the input stream associated with this ARControl to the input stream passed as
|
||||
parameter. The currently set input stream is closed before replacing it.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - An opened input stream. Can be null.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.io.IOException</code> - If an error happened while closing the previous input stream.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="readRawControlMessage()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>readRawControlMessage</h4>
|
||||
<pre>public byte[] readRawControlMessage()
|
||||
throws java.io.IOException</pre>
|
||||
<div class="block"><p>Attempts to read a 2-byte message and returns it as is.</p>
|
||||
|
||||
<p>Returns null if no <code>DataInputStream</code> has been set with
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html#setInputStream(java.io.DataInputStream)"><code>setInputStream(DataInputStream)</code></a>.</p></div>
|
||||
<dl><dt><span class="strong">Returns:</span></dt><dd>The two bytes read from the associated connection as an array.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.io.IOException</code> - If reading the message fails. It is the same IOException
|
||||
as thrown by <code>DataInput.readByte()</code>.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="readAndExecuteMessage()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>readAndExecuteMessage</h4>
|
||||
<pre>public boolean readAndExecuteMessage()
|
||||
throws java.io.IOException</pre>
|
||||
<div class="block"><p>Attempts to read, decode and execute a message, calling the user operation
|
||||
listeners if needed.</p></div>
|
||||
<dl><dt><span class="strong">Returns:</span></dt><dd>True if a message could be read, decoded and executed successfully. False otherwise.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.io.IOException</code> - If reading the message fails. It is the same IOException
|
||||
as thrown by <code>DataInput.readByte()</code> if any.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="decodeMessage(byte[])">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>decodeMessage</h4>
|
||||
<pre>public <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a> decodeMessage(byte[] message)
|
||||
throws java.lang.IllegalArgumentException</pre>
|
||||
<div class="block"><p>Decodes a protocol message encoded as a byte array of two elements as specified
|
||||
in the package definition.</p>
|
||||
|
||||
<p>User actions have precedence over motor recentering and
|
||||
this in turn has precedence over other movement actions.
|
||||
User actions have precedence in decreasing order; that is, user action 1 has
|
||||
precedence over user actions 2 and 3, etc.</p>
|
||||
|
||||
<p>If the message indicates a movement (forward or backward) with all motors off,
|
||||
then it is interpreted as a request to stop all motors. A recenter or user action
|
||||
with all motors off will be decoded as is and must be interpreted by the user.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - A byte array of size two encoding a message recognized by the protocol. If the array
|
||||
has 3 or more elements then only the first 2 are used during the decoding process.</dd>
|
||||
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> instance containing the decoded message.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.lang.IllegalArgumentException</code> - If the array is null or has less than 2 elements.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="executeControlAction(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>executeControlAction</h4>
|
||||
<pre>public boolean executeControlAction(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a> controlAction)
|
||||
throws java.lang.IllegalArgumentException</pre>
|
||||
<div class="block"><p>Executes an already decoded <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a>, calling the user operation
|
||||
listeners if needed.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controlAction</code> - The action to execute.</dd>
|
||||
<dt><span class="strong">Returns:</span></dt><dd>True if the action could be executed successfully. False otherwise.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.lang.IllegalArgumentException</code> - If controlAction is null.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="registerUserActionListener(ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>registerUserActionListener</h4>
|
||||
<pre>public void registerUserActionListener(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol">UserActionListener</a> listener)
|
||||
throws java.lang.IllegalArgumentException</pre>
|
||||
<div class="block"><p>Adds an <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol"><code>UserActionListener</code></a> to this object's listeners list calling it's
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onListenerRegistered()"><code>UserActionListener.onListenerRegistered()</code></a> method. Adding a listener that
|
||||
is already registered does nothing.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - The listener to add.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.lang.IllegalArgumentException</code> - If listener is null.</dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="removeUserActionListener(ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>removeUserActionListener</h4>
|
||||
<pre>public void removeUserActionListener(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol">UserActionListener</a> listener)
|
||||
throws java.lang.IllegalArgumentException</pre>
|
||||
<div class="block"><p>Removes an <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol"><code>UserActionListener</code></a> from this object's listeners list calling it's
|
||||
<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onListenerRemoved()"><code>UserActionListener.onListenerRemoved()</code></a> method. Removing a listener that
|
||||
is NOT on the list does nothing.</p></div>
|
||||
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - The listener to remove.</dd>
|
||||
<dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.lang.IllegalArgumentException</code> - If listener is null.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Prev Class</span></a></li>
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" target="_top">Frames</a></li>
|
||||
<li><a href="NxtARControlProtocol.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><a href="#constructor_summary">Constr</a> | </li>
|
||||
<li><a href="#method_summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="subNavList">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor_detail">Constr</a> | </li>
|
||||
<li><a href="#method_detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="skip-navbar_bottom">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
</body>
|
||||
</html>
|
||||
278
docs/ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html
Normal file
278
docs/ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html
Normal file
@@ -0,0 +1,278 @@
|
||||
<!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 (version 1.7.0_75) on Thu Feb 05 15:36:28 VET 2015 -->
|
||||
<title>UserActionListener</title>
|
||||
<meta name="date" content="2015-02-05">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="UserActionListener";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="topNav"><a name="navbar_top">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Prev Class</span></a></li>
|
||||
<li>Next Class</li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" target="_top">Frames</a></li>
|
||||
<li><a href="UserActionListener.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">ve.ucv.ciens.icaro.libnxtarcontrol</div>
|
||||
<h2 title="Interface UserActionListener" class="title">Interface UserActionListener</h2>
|
||||
</div>
|
||||
<div class="contentContainer">
|
||||
<div class="description">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<hr>
|
||||
<br>
|
||||
<pre>public interface <span class="strong">UserActionListener</span></pre>
|
||||
<div class="block"><p>An object to be notified when an user action has been received in a protocol message.</p></div>
|
||||
<dl><dt><span class="strong">Since:</span></dt>
|
||||
<dd>December 16, 2014</dd></dl>
|
||||
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||||
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||||
<th class="colLast" scope="col">Method and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onListenerRegistered()">onListenerRegistered</a></strong>()</code>
|
||||
<div class="block">Executes a set of instructions just after the listener has been registered with an <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>NxtARControlProtocol</code></a> instance.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onListenerRemoved()">onListenerRemoved</a></strong>()</code>
|
||||
<div class="block">Executes a set of instructions just after the listener has been removed from an <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>NxtARControlProtocol</code></a> instance.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onUserAction1(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor,%20int)">onUserAction1</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motorFlag,
|
||||
int speed)</code>
|
||||
<div class="block">Executes a set of instructions when a <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> is decoded with <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_1"><code>DecodedControlAction.Action.USER_1</code></a>.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onUserAction2(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor,%20int)">onUserAction2</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motorFlag,
|
||||
int speed)</code>
|
||||
<div class="block">Executes a set of instructions when a <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> is decoded with <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_2"><code>DecodedControlAction.Action.USER_2</code></a>.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html#onUserAction3(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor,%20int)">onUserAction3</a></strong>(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motorFlag,
|
||||
int speed)</code>
|
||||
<div class="block">Executes a set of instructions when a <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> is decoded with <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_3"><code>DecodedControlAction.Action.USER_3</code></a>.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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="onListenerRegistered()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>onListenerRegistered</h4>
|
||||
<pre>void onListenerRegistered()</pre>
|
||||
<div class="block"><p>Executes a set of instructions just after the listener has been registered with an <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>NxtARControlProtocol</code></a> instance.</p></div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="onUserAction1(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor, int)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>onUserAction1</h4>
|
||||
<pre>void onUserAction1(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motorFlag,
|
||||
int speed)</pre>
|
||||
<div class="block"><p>Executes a set of instructions when a <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> is decoded with <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_1"><code>DecodedControlAction.Action.USER_1</code></a>.</p></div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="onUserAction2(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor, int)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>onUserAction2</h4>
|
||||
<pre>void onUserAction2(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motorFlag,
|
||||
int speed)</pre>
|
||||
<div class="block"><p>Executes a set of instructions when a <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> is decoded with <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_2"><code>DecodedControlAction.Action.USER_2</code></a>.</p></div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="onUserAction3(ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor, int)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>onUserAction3</h4>
|
||||
<pre>void onUserAction3(<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a> motorFlag,
|
||||
int speed)</pre>
|
||||
<div class="block"><p>Executes a set of instructions when a <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>DecodedControlAction</code></a> is decoded with <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html#USER_3"><code>DecodedControlAction.Action.USER_3</code></a>.</p></div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="onListenerRemoved()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>onListenerRemoved</h4>
|
||||
<pre>void onListenerRemoved()</pre>
|
||||
<div class="block"><p>Executes a set of instructions just after the listener has been removed from an <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>NxtARControlProtocol</code></a> instance.</p></div>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<div class="bottomNav"><a name="navbar_bottom">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/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="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">Prev Class</span></a></li>
|
||||
<li>Next Class</li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" target="_top">Frames</a></li>
|
||||
<li><a href="UserActionListener.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>
|
||||
29
docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-frame.html
Normal file
29
docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-frame.html
Normal file
@@ -0,0 +1,29 @@
|
||||
<!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 (version 1.7.0_75) on Thu Feb 05 15:36:28 VET 2015 -->
|
||||
<title>ve.ucv.ciens.icaro.libnxtarcontrol</title>
|
||||
<meta name="date" content="2015-02-05">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<h1 class="bar"><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html" target="classFrame">ve.ucv.ciens.icaro.libnxtarcontrol</a></h1>
|
||||
<div class="indexContainer">
|
||||
<h2 title="Interfaces">Interfaces</h2>
|
||||
<ul title="Interfaces">
|
||||
<li><a href="UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol" target="classFrame"><i>UserActionListener</i></a></li>
|
||||
</ul>
|
||||
<h2 title="Classes">Classes</h2>
|
||||
<ul title="Classes">
|
||||
<li><a href="DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol" target="classFrame">DecodedControlAction</a></li>
|
||||
<li><a href="NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol" target="classFrame">NxtARControlProtocol</a></li>
|
||||
</ul>
|
||||
<h2 title="Enums">Enums</h2>
|
||||
<ul title="Enums">
|
||||
<li><a href="DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol" target="classFrame">DecodedControlAction.Action</a></li>
|
||||
<li><a href="DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol" target="classFrame">DecodedControlAction.Motor</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
214
docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html
Normal file
214
docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html
Normal file
@@ -0,0 +1,214 @@
|
||||
<!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 (version 1.7.0_75) on Thu Feb 05 15:36:28 VET 2015 -->
|
||||
<title>ve.ucv.ciens.icaro.libnxtarcontrol</title>
|
||||
<meta name="date" content="2015-02-05">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="ve.ucv.ciens.icaro.libnxtarcontrol";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="topNav"><a name="navbar_top">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html">Package</a></li>
|
||||
<li>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>Prev Package</li>
|
||||
<li>Next Package</li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html" target="_top">Frames</a></li>
|
||||
<li><a href="package-summary.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>
|
||||
<a name="skip-navbar_top">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<div class="header">
|
||||
<h1 title="Package" class="title">Package ve.ucv.ciens.icaro.libnxtarcontrol</h1>
|
||||
<div class="docSummary">
|
||||
<div class="block">This package contains a wrapper library and reference implementation of the NxtAR
|
||||
robot control protocol for the LejOS operating system.</div>
|
||||
</div>
|
||||
<p>See: <a href="#package_description">Description</a></p>
|
||||
</div>
|
||||
<div class="contentContainer">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
|
||||
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Interface</th>
|
||||
<th class="colLast" scope="col">Description</th>
|
||||
</tr>
|
||||
<tbody>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol">UserActionListener</a></td>
|
||||
<td class="colLast">
|
||||
<div class="block">An object to be notified when an user action has been received in a protocol message.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
<li class="blockList">
|
||||
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
|
||||
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Class</th>
|
||||
<th class="colLast" scope="col">Description</th>
|
||||
</tr>
|
||||
<tbody>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction</a></td>
|
||||
<td class="colLast">
|
||||
<div class="block">An immutable and pure data class that represents an action decoded from a protocol
|
||||
data message.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol">NxtARControlProtocol</a></td>
|
||||
<td class="colLast">
|
||||
<div class="block">A wrapper around the NxtAR robot control protocol for the LejOS operating system.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
<li class="blockList">
|
||||
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
|
||||
<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Enum</th>
|
||||
<th class="colLast" scope="col">Description</th>
|
||||
</tr>
|
||||
<tbody>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Action</a></td>
|
||||
<td class="colLast">
|
||||
<div class="block">All recognized actions.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol">DecodedControlAction.Motor</a></td>
|
||||
<td class="colLast">
|
||||
<div class="block">All motor ports and possible combinations without repetitions.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="package_description">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h2 title="Package ve.ucv.ciens.icaro.libnxtarcontrol Description">Package ve.ucv.ciens.icaro.libnxtarcontrol Description</h2>
|
||||
<div class="block"><p>This package contains a wrapper library and reference implementation of the NxtAR
|
||||
robot control protocol for the LejOS operating system.</p>
|
||||
|
||||
<p>The protocol is based on 2 byte long data messages that encode a set of motor ports, actions
|
||||
on those motors and the speed of the motors. The first byte encodes a set actions and motors, while the
|
||||
second byte contains an integer number representing the speed to set to the enabled motors. The first
|
||||
byte's bits encode the following data (from least significant to most significant bit): </p>
|
||||
|
||||
<ul>
|
||||
<li>Motor port A enabled.</li>
|
||||
<li>Motor port B enabled.</li>
|
||||
<li>Motor port C enabled.</li>
|
||||
<li>Direction of movement. 0 for backward movement, 1 for forward movement.</li>
|
||||
<li>Request to return the enabled motors to their initial positions.</li>
|
||||
<li>Customizable user action 1.</li>
|
||||
<li>Customizable user action 2.</li>
|
||||
<li>Customizable user action 3.</li>
|
||||
</ul>
|
||||
|
||||
<p>This bits are decoded using the binary masks defined in <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>NxtARControlProtocol</code></a>.
|
||||
This mechanism allows to set the state or execute an action on multiple motors simultaneously. The user actions are
|
||||
executed using callback objects registered with the aforementioned class.</p>
|
||||
|
||||
<p>The <a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><code>NxtARControlProtocol</code></a> class includes methods to
|
||||
read, decode and execute a protocol message, independently of how those messages are generated. An example
|
||||
would be messages read from a Bluetooth or USB stream, as well as messages generated by the application
|
||||
that is using the library.</p></div>
|
||||
</div>
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<div class="bottomNav"><a name="navbar_bottom">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html">Package</a></li>
|
||||
<li>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>Prev Package</li>
|
||||
<li>Next Package</li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html" target="_top">Frames</a></li>
|
||||
<li><a href="package-summary.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>
|
||||
<a name="skip-navbar_bottom">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
</body>
|
||||
</html>
|
||||
138
docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-tree.html
Normal file
138
docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-tree.html
Normal file
@@ -0,0 +1,138 @@
|
||||
<!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 (version 1.7.0_75) on Thu Feb 05 15:36:28 VET 2015 -->
|
||||
<title>ve.ucv.ciens.icaro.libnxtarcontrol Class Hierarchy</title>
|
||||
<meta name="date" content="2015-02-05">
|
||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="ve.ucv.ciens.icaro.libnxtarcontrol Class Hierarchy";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="topNav"><a name="navbar_top">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="navBarCell1Rev">Tree</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>Prev</li>
|
||||
<li>Next</li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/package-tree.html" target="_top">Frames</a></li>
|
||||
<li><a href="package-tree.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>
|
||||
<a name="skip-navbar_top">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<div class="header">
|
||||
<h1 class="title">Hierarchy For Package ve.ucv.ciens.icaro.libnxtarcontrol</h1>
|
||||
</div>
|
||||
<div class="contentContainer">
|
||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li type="circle">java.lang.Object
|
||||
<ul>
|
||||
<li type="circle">ve.ucv.ciens.icaro.libnxtarcontrol.<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">DecodedControlAction</span></a></li>
|
||||
<li type="circle">ve.ucv.ciens.icaro.libnxtarcontrol.<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html" title="class in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">NxtARControlProtocol</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
|
||||
<ul>
|
||||
<li type="circle">ve.ucv.ciens.icaro.libnxtarcontrol.<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html" title="interface in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">UserActionListener</span></a></li>
|
||||
</ul>
|
||||
<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
|
||||
<ul>
|
||||
<li type="circle">java.lang.Object
|
||||
<ul>
|
||||
<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
|
||||
<ul>
|
||||
<li type="circle">ve.ucv.ciens.icaro.libnxtarcontrol.<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">DecodedControlAction.Action</span></a></li>
|
||||
<li type="circle">ve.ucv.ciens.icaro.libnxtarcontrol.<a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html" title="enum in ve.ucv.ciens.icaro.libnxtarcontrol"><span class="strong">DecodedControlAction.Motor</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<div class="bottomNav"><a name="navbar_bottom">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="navList" title="Navigation">
|
||||
<li><a href="../../../../../ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="navBarCell1Rev">Tree</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>Prev</li>
|
||||
<li>Next</li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../../index.html?ve/ucv/ciens/icaro/libnxtarcontrol/package-tree.html" target="_top">Frames</a></li>
|
||||
<li><a href="package-tree.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>
|
||||
<a name="skip-navbar_bottom">
|
||||
<!-- -->
|
||||
</a></div>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user