API documented

iscar-ucm · Apr 23, 2024 · a686f61 · a686f61
1 parent 2ff928f
commit a686f61
Show file tree

Hide file tree

Showing 169 changed files with 2,846 additions and 1,177 deletions.
diff --git a/docs/apidocs/allclasses-index.html b/docs/apidocs/allclasses-index.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="es">
 <head>
-<!-- Generated by javadoc (11.0.22) on Wed Apr 10 12:48:30 CEST 2024 -->
-<title>All Classes (xdevs 4.1 API)</title>
+<!-- Generated by javadoc (11.0.22) on Tue Apr 23 11:52:13 CEST 2024 -->
+<title>All Classes (xdevs 24.04 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-04-10">
+<meta name="dc.created" content="2024-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="All Classes (xdevs 4.1 API)";
+            parent.document.title="All Classes (xdevs 24.04 API)";
         }
     }
     catch(err) {
@@ -211,13 +211,13 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/examples/devstone/DevStone.html" title="class in xdevs.core.examples.devstone">DevStone</a></td>
 <th class="colLast" scope="row">
-<div class="block">Coupled model to study the performance using DEVStone</div>
+<div class="block">Coupled model to study the performance using DEVStone.</div>
 </th>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/devstone/DevStoneAtomic.html" title="class in xdevs.core.examples.devstone">DevStoneAtomic</a></td>
 <th class="colLast" scope="row">
-<div class="block">Atomic model to study the performance using the DEVStone benchmark</div>
+<div class="block">DEVStone atomic model</div>
 </th>
 </tr>
 <tr id="i17" class="rowColor">
@@ -234,14 +234,14 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/examples/devstone/DevStoneCoupledHOmem.html" title="class in xdevs.core.examples.devstone">DevStoneCoupledHOmem</a></td>
-<th class="colLast" scope="row">
-<div class="block">Coupled model to study the performance HO DEVStone models</div>
+<th class="colLast" scope="row">Deprecated.
+<div class="deprecationComment">This class is deprecated and will be removed in the future.</div>
 </th>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/devstone/DevStoneCoupledHOmod.html" title="class in xdevs.core.examples.devstone">DevStoneCoupledHOmod</a></td>
 <th class="colLast" scope="row">
-<div class="block">Coupled model to study the performance HO DEVStone models</div>
+<div class="block">Coupled model to study the performance HOmod DEVStone models</div>
 </th>
 </tr>
 <tr id="i21" class="rowColor">
@@ -258,11 +258,15 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
 </tr>
 <tr id="i23" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/examples/devstone/DevStoneSimulation.html" title="class in xdevs.core.examples.devstone">DevStoneSimulation</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Class to perform DEVStone simulations</div>
+</th>
 </tr>
 <tr id="i24" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/devstone/DevStoneSimulation.BenchmarkType.html" title="enum in xdevs.core.examples.devstone">DevStoneSimulation.BenchmarkType</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Enum to define the type of benchmark</div>
+</th>
 </tr>
 <tr id="i25" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/examples/devstone/Dhrystone.html" title="class in xdevs.core.examples.devstone">Dhrystone</a></td>
@@ -288,31 +292,45 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
 </tr>
 <tr id="i28" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/efp/Ef.html" title="class in xdevs.core.examples.efp">Ef</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Experimental-Frame DEVS coupled model.</div>
+</th>
 </tr>
 <tr id="i29" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/examples/efp/Efp.html" title="class in xdevs.core.examples.efp">Efp</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Experimental-Frame + Processor (EFP) DEVS coupled model.</div>
+</th>
 </tr>
 <tr id="i30" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/dynamic/Factory.html" title="class in xdevs.core.examples.dynamic">Factory</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Factory with dynamic number of machines.</div>
+</th>
 </tr>
 <tr id="i31" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/examples/efp/Generator.html" title="class in xdevs.core.examples.efp">Generator</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Generator of jobs.</div>
+</th>
 </tr>
 <tr id="i32" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/efp/Gpt.html" title="class in xdevs.core.examples.efp">Gpt</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Gpt model.</div>
+</th>
 </tr>
 <tr id="i33" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/examples/efp/GptXml.html" title="class in xdevs.core.examples.efp">GptXml</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Gpt XML simulation model.</div>
+</th>
 </tr>
 <tr id="i34" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/efp/Job.html" title="class in xdevs.core.examples.efp">Job</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Job class for the GPT or EFP examples.</div>
+</th>
 </tr>
 <tr id="i35" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/util/LoggerFormatter.html" title="class in xdevs.core.util">LoggerFormatter</a></td>
@@ -322,7 +340,9 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
 </tr>
 <tr id="i36" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/dynamic/Machine.html" title="class in xdevs.core.examples.dynamic">Machine</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Machine class for the Factory example.</div>
+</th>
 </tr>
 <tr id="i37" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/simulation/distributed/MessageDistributed.html" title="class in xdevs.core.simulation.distributed">MessageDistributed</a></td>
@@ -331,33 +351,37 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
 </th>
 </tr>
 <tr id="i38" class="altColor">
-<td class="colFirst"><a href="xdevs/core/examples/distributed/gpt/Node.html" title="class in xdevs.core.examples.distributed.gpt">Node</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
-</tr>
-<tr id="i39" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/simulation/distributed/PingMessage.html" title="class in xdevs.core.simulation.distributed">PingMessage</a></td>
 <th class="colLast" scope="row">
 <div class="block">Class to transmit a message to a remote host and receive the response.</div>
 </th>
 </tr>
-<tr id="i40" class="altColor">
+<tr id="i39" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/modeling/Port.html" title="class in xdevs.core.modeling">Port</a>&lt;<a href="xdevs/core/modeling/Port.html" title="type parameter in Port">E</a>&gt;</td>
 <th class="colLast" scope="row">
 <div class="block">Class for the ports of the components in the DEVS formalism.</div>
 </th>
 </tr>
-<tr id="i41" class="rowColor">
+<tr id="i40" class="altColor">
 <td class="colFirst"><a href="xdevs/core/examples/efp/Processor.html" title="class in xdevs.core.examples.efp">Processor</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Processor of jobs.</div>
+</th>
 </tr>
-<tr id="i42" class="altColor">
+<tr id="i41" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/simulation/realtime/RTCentralCoordinator.html" title="class in xdevs.core.simulation.realtime">RTCentralCoordinator</a></td>
 <th class="colLast" scope="row">
 <div class="block">Real-time central coordinator
 
  This class implements a real-time central coordinator for DEVS models.</div>
 </th>
 </tr>
+<tr id="i42" class="altColor">
+<td class="colFirst"><a href="xdevs/core/examples/distributed/gpt/RunDistributedSimulation.html" title="class in xdevs.core.examples.distributed.gpt">RunDistributedSimulation</a></td>
+<th class="colLast" scope="row">
+<div class="block">Node class to run a distributed simulation.</div>
+</th>
+</tr>
 <tr id="i43" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/simulation/SimulationClock.html" title="class in xdevs.core.simulation">SimulationClock</a></td>
 <th class="colLast" scope="row">
@@ -400,7 +424,11 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
 </tr>
 <tr id="i49" class="rowColor">
 <td class="colFirst"><a href="xdevs/core/examples/efp/Transducer.html" title="class in xdevs.core.examples.efp">Transducer</a></td>
-<th class="colLast" scope="row">&nbsp;</th>
+<th class="colLast" scope="row">
+<div class="block">Transducer
+
+ The transducer collects statistics about the jobs.</div>
+</th>
 </tr>
 </table>
 </li>

diff --git a/docs/apidocs/allclasses.html b/docs/apidocs/allclasses.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="es">
 <head>
-<!-- Generated by javadoc (11.0.22) on Wed Apr 10 12:48:30 CEST 2024 -->
-<title>All Classes (xdevs 4.1 API)</title>
+<!-- Generated by javadoc (11.0.22) on Tue Apr 23 11:52:13 CEST 2024 -->
+<title>All Classes (xdevs 24.04 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-04-10">
+<meta name="dc.created" content="2024-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -61,11 +61,11 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="xdevs/core/util/LoggerFormatter.html" title="class in xdevs.core.util">LoggerFormatter</a></li>
 <li><a href="xdevs/core/examples/dynamic/Machine.html" title="class in xdevs.core.examples.dynamic">Machine</a></li>
 <li><a href="xdevs/core/simulation/distributed/MessageDistributed.html" title="class in xdevs.core.simulation.distributed">MessageDistributed</a></li>
-<li><a href="xdevs/core/examples/distributed/gpt/Node.html" title="class in xdevs.core.examples.distributed.gpt">Node</a></li>
 <li><a href="xdevs/core/simulation/distributed/PingMessage.html" title="class in xdevs.core.simulation.distributed">PingMessage</a></li>
 <li><a href="xdevs/core/modeling/Port.html" title="class in xdevs.core.modeling">Port</a></li>
 <li><a href="xdevs/core/examples/efp/Processor.html" title="class in xdevs.core.examples.efp">Processor</a></li>
 <li><a href="xdevs/core/simulation/realtime/RTCentralCoordinator.html" title="class in xdevs.core.simulation.realtime">RTCentralCoordinator</a></li>
+<li><a href="xdevs/core/examples/distributed/gpt/RunDistributedSimulation.html" title="class in xdevs.core.examples.distributed.gpt">RunDistributedSimulation</a></li>
 <li><a href="xdevs/core/simulation/SimulationClock.html" title="class in xdevs.core.simulation">SimulationClock</a></li>
 <li><a href="xdevs/core/simulation/Simulator.html" title="class in xdevs.core.simulation">Simulator</a></li>
 <li><a href="xdevs/core/simulation/distributed/SimulatorDistributed.html" title="class in xdevs.core.simulation.distributed">SimulatorDistributed</a></li>

diff --git a/docs/apidocs/allpackages-index.html b/docs/apidocs/allpackages-index.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="es">
 <head>
-<!-- Generated by javadoc (11.0.22) on Wed Apr 10 12:48:30 CEST 2024 -->
-<title>All Packages (xdevs 4.1 API)</title>
+<!-- Generated by javadoc (11.0.22) on Tue Apr 23 11:52:13 CEST 2024 -->
+<title>All Packages (xdevs 24.04 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-04-10">
+<meta name="dc.created" content="2024-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="All Packages (xdevs 4.1 API)";
+            parent.document.title="All Packages (xdevs 24.04 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/constant-values.html b/docs/apidocs/constant-values.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="es">
 <head>
-<!-- Generated by javadoc (11.0.22) on Wed Apr 10 12:48:30 CEST 2024 -->
-<title>Constant Field Values (xdevs 4.1 API)</title>
+<!-- Generated by javadoc (11.0.22) on Tue Apr 23 11:52:13 CEST 2024 -->
+<title>Constant Field Values (xdevs 24.04 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-04-10">
+<meta name="dc.created" content="2024-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Constant Field Values (xdevs 4.1 API)";
+            parent.document.title="Constant Field Values (xdevs 24.04 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/deprecated-list.html b/docs/apidocs/deprecated-list.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="es">
 <head>
-<!-- Generated by javadoc (11.0.22) on Wed Apr 10 12:48:30 CEST 2024 -->
-<title>Deprecated List (xdevs 4.1 API)</title>
+<!-- Generated by javadoc (11.0.22) on Tue Apr 23 11:52:13 CEST 2024 -->
+<title>Deprecated List (xdevs 24.04 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-04-10">
+<meta name="dc.created" content="2024-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Deprecated List (xdevs 4.1 API)";
+            parent.document.title="Deprecated List (xdevs 24.04 API)";
         }
     }
     catch(err) {
@@ -98,10 +98,33 @@
 <h1 title="Deprecated API" class="title">Deprecated API</h1>
 <h2 title="Contents">Contents</h2>
 <ul>
+<li><a href="#class">Classes</a></li>
 <li><a href="#method">Methods</a></li>
 </ul>
 </div>
-<div class="contentContainer"><a id="method">
+<div class="contentContainer"><a id="class">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<table class="deprecatedSummary">
+<caption><span>Classes</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Class</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<th class="colDeprecatedItemName" scope="row"><a href="xdevs/core/examples/devstone/DevStoneCoupledHOmem.html" title="class in xdevs.core.examples.devstone">xdevs.core.examples.devstone.DevStoneCoupledHOmem</a></th>
+<td class="colLast">
+<div class="deprecationComment">This class is deprecated and will be removed in the future.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+<a id="method">
 <!--   -->
 </a>
 <ul class="blockList">

diff --git a/docs/apidocs/help-doc.html b/docs/apidocs/help-doc.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="es">
 <head>
-<!-- Generated by javadoc (11.0.22) on Wed Apr 10 12:48:30 CEST 2024 -->
-<title>API Help (xdevs 4.1 API)</title>
+<!-- Generated by javadoc (11.0.22) on Tue Apr 23 11:52:13 CEST 2024 -->
+<title>API Help (xdevs 24.04 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-04-10">
+<meta name="dc.created" content="2024-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="API Help (xdevs 4.1 API)";
+            parent.document.title="API Help (xdevs 24.04 API)";
         }
     }
     catch(err) {