Documentation - 2023-07-28

Pera-Swarm · Jul 28, 2023 · 606465a · 606465a
1 parent e0d39ac
commit 606465a
Show file tree

Hide file tree

Showing 98 changed files with 19,239 additions and 0 deletions.
diff --git a/docs/Robots/MyTestRobot.html b/docs/Robots/MyTestRobot.html
@@ -0,0 +1,378 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_77) on Fri Jul 28 22:47:34 IST 2023 -->
+<title>MyTestRobot</title>
+<meta name="date" content="2023-07-28">
+<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
+<script type="text/javascript" src="../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+    try {
+        if (location.href.indexOf('is-external=true') == -1) {
+            parent.document.title="MyTestRobot";
+        }
+    }
+    catch(err) {
+    }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../deprecated-list.html">Deprecated</a></li>
+<li><a href="../index-files/index-1.html">Index</a></li>
+<li><a href="../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev&nbsp;Class</li>
+<li>Next&nbsp;Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../index.html?Robots/MyTestRobot.html" target="_top">Frames</a></li>
+<li><a href="MyTestRobot.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#fields.inherited.from.class.swarm.robot.Robot">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">Robots</div>
+<h2 title="Class MyTestRobot" class="title">Class MyTestRobot</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../swarm/robot/Robot.html" title="class in swarm.robot">swarm.robot.Robot</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="../swarm/robot/VirtualRobot.html" title="class in swarm.robot">swarm.robot.VirtualRobot</a></li>
+<li>
+<ul class="inheritance">
+<li>Robots.MyTestRobot</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.lang.Runnable, <a href="../swarm/Interfaces/IRobotState.html" title="interface in swarm.Interfaces">IRobotState</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">MyTestRobot</span>
+extends <a href="../swarm/robot/VirtualRobot.html" title="class in swarm.robot">VirtualRobot</a></pre>
+</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>
+<ul class="blockList">
+<li class="blockList"><a name="nested.classes.inherited.from.class.swarm.Interfaces.IRobotState">
+<!--   -->
+</a>
+<h3>Nested classes/interfaces inherited from interface&nbsp;swarm.Interfaces.<a href="../swarm/Interfaces/IRobotState.html" title="interface in swarm.Interfaces">IRobotState</a></h3>
+<code><a href="../swarm/Interfaces/IRobotState.robotState.html" title="enum in swarm.Interfaces">IRobotState.robotState</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!--   -->
+</a>
+<h3>Field Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.swarm.robot.Robot">
+<!--   -->
+</a>
+<h3>Fields inherited from class&nbsp;swarm.robot.<a href="../swarm/robot/Robot.html" title="class in swarm.robot">Robot</a></h3>
+<code><a href="../swarm/robot/Robot.html#colorSensor">colorSensor</a>, <a href="../swarm/robot/Robot.html#coordinates">coordinates</a>, <a href="../swarm/robot/Robot.html#directedComm">directedComm</a>, <a href="../swarm/robot/Robot.html#distSensor">distSensor</a>, <a href="../swarm/robot/Robot.html#id">id</a>, <a href="../swarm/robot/Robot.html#motion">motion</a>, <a href="../swarm/robot/Robot.html#neoPixel">neoPixel</a>, <a href="../swarm/robot/Robot.html#proximitySensor">proximitySensor</a>, <a href="../swarm/robot/Robot.html#reality">reality</a>, <a href="../swarm/robot/Robot.html#robotMQTT">robotMQTT</a>, <a href="../swarm/robot/Robot.html#robotMqttClient">robotMqttClient</a>, <a href="../swarm/robot/Robot.html#simpleComm">simpleComm</a>, <a href="../swarm/robot/Robot.html#state">state</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!--   -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#MyTestRobot-int-double-double-double-">MyTestRobot</a></span>(int&nbsp;id,
+           double&nbsp;x,
+           double&nbsp;y,
+           double&nbsp;heading)</code>&nbsp;</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!--   -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#communicationInterrupt-java.lang.String-">communicationInterrupt</a></span>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#loop--">loop</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#setup--">setup</a></span>()</code>&nbsp;</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.swarm.robot.VirtualRobot">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;swarm.robot.<a href="../swarm/robot/VirtualRobot.html" title="class in swarm.robot">VirtualRobot</a></h3>
+<code><a href="../swarm/robot/VirtualRobot.html#interrupt--">interrupt</a>, <a href="../swarm/robot/VirtualRobot.html#sensorInterrupt-java.lang.String-java.lang.String-">sensorInterrupt</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.swarm.robot.Robot">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;swarm.robot.<a href="../swarm/robot/Robot.html" title="class in swarm.robot">Robot</a></h3>
+<code><a href="../swarm/robot/Robot.html#delay-int-">delay</a>, <a href="../swarm/robot/Robot.html#getId--">getId</a>, <a href="../swarm/robot/Robot.html#handleSubscribeQueue--">handleSubscribeQueue</a>, <a href="../swarm/robot/Robot.html#reset--">reset</a>, <a href="../swarm/robot/Robot.html#run--">run</a>, <a href="../swarm/robot/Robot.html#start--">start</a>, <a href="../swarm/robot/Robot.html#stop--">stop</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;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="MyTestRobot-int-double-double-double-">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>MyTestRobot</h4>
+<pre>public&nbsp;MyTestRobot(int&nbsp;id,
+                   double&nbsp;x,
+                   double&nbsp;y,
+                   double&nbsp;heading)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="setup--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setup</h4>
+<pre>public&nbsp;void&nbsp;setup()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a href="../swarm/robot/Robot.html#setup--">setup</a></code>&nbsp;in class&nbsp;<code><a href="../swarm/robot/Robot.html" title="class in swarm.robot">Robot</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="loop--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>loop</h4>
+<pre>public&nbsp;void&nbsp;loop()
+          throws java.lang.Exception</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../swarm/Interfaces/IRobotState.html#loop--">loop</a></code>&nbsp;in interface&nbsp;<code><a href="../swarm/Interfaces/IRobotState.html" title="interface in swarm.Interfaces">IRobotState</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a href="../swarm/robot/VirtualRobot.html#loop--">loop</a></code>&nbsp;in class&nbsp;<code><a href="../swarm/robot/VirtualRobot.html" title="class in swarm.robot">VirtualRobot</a></code></dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.Exception</code></dd>
+</dl>
+</li>
+</ul>
+<a name="communicationInterrupt-java.lang.String-">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>communicationInterrupt</h4>
+<pre>public&nbsp;void&nbsp;communicationInterrupt(java.lang.String&nbsp;msg)</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../swarm/Interfaces/IRobotState.html#communicationInterrupt-java.lang.String-">communicationInterrupt</a></code>&nbsp;in interface&nbsp;<code><a href="../swarm/Interfaces/IRobotState.html" title="interface in swarm.Interfaces">IRobotState</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><a href="../swarm/robot/VirtualRobot.html#communicationInterrupt-java.lang.String-">communicationInterrupt</a></code>&nbsp;in class&nbsp;<code><a href="../swarm/robot/VirtualRobot.html" title="class in swarm.robot">VirtualRobot</a></code></dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../deprecated-list.html">Deprecated</a></li>
+<li><a href="../index-files/index-1.html">Index</a></li>
+<li><a href="../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev&nbsp;Class</li>
+<li>Next&nbsp;Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../index.html?Robots/MyTestRobot.html" target="_top">Frames</a></li>
+<li><a href="MyTestRobot.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#fields.inherited.from.class.swarm.robot.Robot">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
diff --git a/docs/Robots/package-frame.html b/docs/Robots/package-frame.html
@@ -0,0 +1,20 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_77) on Fri Jul 28 22:47:34 IST 2023 -->
+<title>Robots</title>
+<meta name="date" content="2023-07-28">
+<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
+<script type="text/javascript" src="../script.js"></script>
+</head>
+<body>
+<h1 class="bar"><a href="../Robots/package-summary.html" target="classFrame">Robots</a></h1>
+<div class="indexContainer">
+<h2 title="Classes">Classes</h2>
+<ul title="Classes">
+<li><a href="MyTestRobot.html" title="class in Robots" target="classFrame">MyTestRobot</a></li>
+</ul>
+</div>
+</body>
+</html>