doc: javadoc update to 1.12.3

org-arl · Mar 17, 2024 · 239e7fa · 239e7fa
1 parent 64d610f
commit 239e7fa
Show file tree

Hide file tree

Showing 121 changed files with 286 additions and 241 deletions.
diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (fjage 1.12.0 API)</title>
+<title>All Classes (fjage 1.12.3 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (fjage 1.12.0 API)</title>
+<title>All Classes (fjage 1.12.3 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadoc/constant-values.html b/docs/javadoc/constant-values.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Constant Field Values (fjage 1.12.0 API)</title>
+<title>Constant Field Values (fjage 1.12.3 API)</title>
 <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="Constant Field Values (fjage 1.12.0 API)";
+ parent.document.title="Constant Field Values (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/deprecated-list.html b/docs/javadoc/deprecated-list.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Deprecated List (fjage 1.12.0 API)</title>
+<title>Deprecated List (fjage 1.12.3 API)</title>
 <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="Deprecated List (fjage 1.12.0 API)";
+ parent.document.title="Deprecated List (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/help-doc.html b/docs/javadoc/help-doc.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>API Help (fjage 1.12.0 API)</title>
+<title>API Help (fjage 1.12.3 API)</title>
 <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="API Help (fjage 1.12.0 API)";
+ parent.document.title="API Help (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Index (fjage 1.12.0 API)</title>
+<title>Index (fjage 1.12.3 API)</title>
 <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="Index (fjage 1.12.0 API)";
+ parent.document.title="Index (fjage 1.12.3 API)";
  }
  }
  catch(err) {
@@ -3423,12 +3423,18 @@ <h2 class="title">S</h2>
 <dd>
 <div class="block">Starts the web server.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="org/arl/fjage/Container.html#start--">start()</a></span> - Method in class org.arl.fjage.<a href="org/arl/fjage/Container.html" title="class in org.arl.fjage">Container</a></dt>
+<dd>
+<div class="block">Starts the container and all agents in it.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="org/arl/fjage/DiscreteEventSimulator.html#start--">start()</a></span> - Method in class org.arl.fjage.<a href="org/arl/fjage/DiscreteEventSimulator.html" title="class in org.arl.fjage">DiscreteEventSimulator</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/arl/fjage/Platform.html#start--">start()</a></span> - Method in class org.arl.fjage.<a href="org/arl/fjage/Platform.html" title="class in org.arl.fjage">Platform</a></dt>
 <dd>
 <div class="block">Starts all containers on the platform.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="org/arl/fjage/remote/SlaveContainer.html#start--">start()</a></span> - Method in class org.arl.fjage.remote.<a href="org/arl/fjage/remote/SlaveContainer.html" title="class in org.arl.fjage.remote">SlaveContainer</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/arl/fjage/connectors/WebServer.html#started">started</a></span> - Variable in class org.arl.fjage.connectors.<a href="org/arl/fjage/connectors/WebServer.html" title="class in org.arl.fjage.connectors">WebServer</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/arl/fjage/FSMBehavior.State.html#State-java.lang.Object-">State(Object)</a></span> - Constructor for class org.arl.fjage.<a href="org/arl/fjage/FSMBehavior.State.html" title="class in org.arl.fjage">FSMBehavior.State</a></dt>

diff --git a/docs/javadoc/index.html b/docs/javadoc/index.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>fjage 1.12.0 API</title>
+<title>fjage 1.12.3 API</title>
 <script type="text/javascript">
  tmpTargetPage = "" + window.location.search;
  if (tmpTargetPage != "" && tmpTargetPage != "undefined")

diff --git a/docs/javadoc/org/arl/fjage/Agent.html b/docs/javadoc/org/arl/fjage/Agent.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Agent (fjage 1.12.0 API)</title>
+<title>Agent (fjage 1.12.3 API)</title>
 <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="Agent (fjage 1.12.0 API)";
+ parent.document.title="Agent (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/AgentID.html b/docs/javadoc/org/arl/fjage/AgentID.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>AgentID (fjage 1.12.0 API)</title>
+<title>AgentID (fjage 1.12.3 API)</title>
 <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="AgentID (fjage 1.12.0 API)";
+ parent.document.title="AgentID (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/AgentLocalRandom.html b/docs/javadoc/org/arl/fjage/AgentLocalRandom.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>AgentLocalRandom (fjage 1.12.0 API)</title>
+<title>AgentLocalRandom (fjage 1.12.3 API)</title>
 <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="AgentLocalRandom (fjage 1.12.0 API)";
+ parent.document.title="AgentLocalRandom (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/AgentState.html b/docs/javadoc/org/arl/fjage/AgentState.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>AgentState (fjage 1.12.0 API)</title>
+<title>AgentState (fjage 1.12.3 API)</title>
 <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="AgentState (fjage 1.12.0 API)";
+ parent.document.title="AgentState (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/BackoffBehavior.html b/docs/javadoc/org/arl/fjage/BackoffBehavior.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>BackoffBehavior (fjage 1.12.0 API)</title>
+<title>BackoffBehavior (fjage 1.12.3 API)</title>
 <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="BackoffBehavior (fjage 1.12.0 API)";
+ parent.document.title="BackoffBehavior (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/Behavior.html b/docs/javadoc/org/arl/fjage/Behavior.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Behavior (fjage 1.12.0 API)</title>
+<title>Behavior (fjage 1.12.3 API)</title>
 <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="Behavior (fjage 1.12.0 API)";
+ parent.document.title="Behavior (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/BriefLogFormatter.html b/docs/javadoc/org/arl/fjage/BriefLogFormatter.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>BriefLogFormatter (fjage 1.12.0 API)</title>
+<title>BriefLogFormatter (fjage 1.12.3 API)</title>
 <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="BriefLogFormatter (fjage 1.12.0 API)";
+ parent.document.title="BriefLogFormatter (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/Callback.html b/docs/javadoc/org/arl/fjage/Callback.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Callback (fjage 1.12.0 API)</title>
+<title>Callback (fjage 1.12.3 API)</title>
 <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="Callback (fjage 1.12.0 API)";
+ parent.document.title="Callback (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/Container.html b/docs/javadoc/org/arl/fjage/Container.html
@@ -3,21 +3,21 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Container (fjage 1.12.0 API)</title>
+<title>Container (fjage 1.12.3 API)</title>
 <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="Container (fjage 1.12.0 API)";
+ parent.document.title="Container (fjage 1.12.3 API)";
  }
  }
  catch(err) {
  }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -439,25 +439,31 @@ <h3>Method Summary</h3>
 </td>
 </tr>
 <tr id="i31" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/arl/fjage/Container.html#start--">start</a></span>()</code>
+<div class="block">Starts the container and all agents in it.</div>
+</td>
+</tr>
+<tr id="i32" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/arl/fjage/Container.html#subscribe-org.arl.fjage.AgentID-org.arl.fjage.AgentID-">subscribe</a></span>(<a href="../../../org/arl/fjage/AgentID.html" title="class in org.arl.fjage">AgentID</a>&nbsp;aid,
  <a href="../../../org/arl/fjage/AgentID.html" title="class in org.arl.fjage">AgentID</a>&nbsp;topic)</code>
 <div class="block">Subscribes an agent to messages sent to a topic.</div>
 </td>
 </tr>
-<tr id="i32" class="altColor">
+<tr id="i33" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/arl/fjage/Container.html#toString--">toString</a></span>()</code>
 <div class="block">Gets a string representation of the container.</div>
 </td>
 </tr>
-<tr id="i33" class="rowColor">
+<tr id="i34" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/arl/fjage/Container.html#unsubscribe-org.arl.fjage.AgentID-">unsubscribe</a></span>(<a href="../../../org/arl/fjage/AgentID.html" title="class in org.arl.fjage">AgentID</a>&nbsp;aid)</code>
 <div class="block">Unsubscribes an agent from all topics.</div>
 </td>
 </tr>
-<tr id="i34" class="altColor">
+<tr id="i35" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/arl/fjage/Container.html#unsubscribe-org.arl.fjage.AgentID-org.arl.fjage.AgentID-">unsubscribe</a></span>(<a href="../../../org/arl/fjage/AgentID.html" title="class in org.arl.fjage">AgentID</a>&nbsp;aid,
  <a href="../../../org/arl/fjage/AgentID.html" title="class in org.arl.fjage">AgentID</a>&nbsp;topic)</code>
@@ -1161,6 +1167,17 @@ <h4>initComplete</h4>
  This is called after all agents have been initialized.</div>
 </li>
 </ul>
+<a name="start--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start</h4>
+<pre>protected&nbsp;void&nbsp;start()</pre>
+<div class="block">Starts the container and all agents in it.
+ This should be called after init().</div>
+</li>
+</ul>
 <a name="shutdown--">
 <!-- -->
 </a>

diff --git a/docs/javadoc/org/arl/fjage/CyclicBehavior.html b/docs/javadoc/org/arl/fjage/CyclicBehavior.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>CyclicBehavior (fjage 1.12.0 API)</title>
+<title>CyclicBehavior (fjage 1.12.3 API)</title>
 <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="CyclicBehavior (fjage 1.12.0 API)";
+ parent.document.title="CyclicBehavior (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/DiscreteEventSimulator.html b/docs/javadoc/org/arl/fjage/DiscreteEventSimulator.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>DiscreteEventSimulator (fjage 1.12.0 API)</title>
+<title>DiscreteEventSimulator (fjage 1.12.3 API)</title>
 <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="DiscreteEventSimulator (fjage 1.12.0 API)";
+ parent.document.title="DiscreteEventSimulator (fjage 1.12.3 API)";
  }
  }
  catch(err) {

diff --git a/docs/javadoc/org/arl/fjage/FSMBehavior.State.html b/docs/javadoc/org/arl/fjage/FSMBehavior.State.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>FSMBehavior.State (fjage 1.12.0 API)</title>
+<title>FSMBehavior.State (fjage 1.12.3 API)</title>
 <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="FSMBehavior.State (fjage 1.12.0 API)";
+ parent.document.title="FSMBehavior.State (fjage 1.12.3 API)";
  }
  }
  catch(err) {