diff --git a/examples/src/SimkitOpenDis7Examples/ArrivalProcess.java b/examples/src/SimkitOpenDis7Examples/ArrivalProcess.java
index bf8e2528325771fce2fe68f24ec716bc7e7e9205..8ff1b0c41204af0334617c636178c73e17ffb49d 100644
--- a/examples/src/SimkitOpenDis7Examples/ArrivalProcess.java
+++ b/examples/src/SimkitOpenDis7Examples/ArrivalProcess.java
@@ -8,7 +8,7 @@ import simkit.random.RandomVariate;
* events is scheduled based on an inter arrival time random variate. The state
* variable, simply counts the number of these arrivals.
*
- * @author ahbuss
+ * @author abuss@nps.edu
*/
public class ArrivalProcess extends SimEntityBase {
@@ -72,6 +72,7 @@ public class ArrivalProcess extends SimEntityBase {
}
/**
+ * accessor method to get a state variable
* @return the interarrivalTimeGenerator
*/
public RandomVariate getInterarrivalTimeGenerator() {
@@ -79,6 +80,7 @@ public class ArrivalProcess extends SimEntityBase {
}
/**
+ * accessor method to set a state variable
* @param interarrivalTimeGenerator the interarrivalTimeGenerator to set
*/
public void setInterarrivalTimeGenerator(RandomVariate interarrivalTimeGenerator) {
@@ -86,6 +88,7 @@ public class ArrivalProcess extends SimEntityBase {
}
/**
+ * accessor method to get a state variable
* @return the numberArrivals
*/
public int getNumberArrivals() {
diff --git a/examples/src/SimkitOpenDis7Examples/ArrivalProcessOpenDis7.java b/examples/src/SimkitOpenDis7Examples/ArrivalProcessOpenDis7.java
index 29296c86fd51a8060ca1f7264271490ffb853810..72c1e961b04945d0f9cb23e4967142ed24b1682b 100644
--- a/examples/src/SimkitOpenDis7Examples/ArrivalProcessOpenDis7.java
+++ b/examples/src/SimkitOpenDis7Examples/ArrivalProcessOpenDis7.java
@@ -14,7 +14,7 @@ import simkit.random.RandomVariate;
* @see SimkitOpenDis7Examples.SimpleServer
* @see SimkitOpenDis7Examples.run.RunSimpleServerOpenDis7
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/raw/master/examples/src/SimkitOpenDis7Examples/documentation/ArrivalProcessDisPdu.png">ArrivalProcessDisPdu.png</a>
- * @author ahbuss
+ * @author abuss@nps.edu
* @author brutzman
*/
public class ArrivalProcessOpenDis7 extends SimEntityBase {
@@ -98,6 +98,7 @@ public class ArrivalProcessOpenDis7 extends SimEntityBase {
}
/**
+ * accessor method to get a state variable
* @return the interarrivalTimeGenerator
*/
public RandomVariate getInterarrivalTimeGenerator() {
@@ -105,6 +106,7 @@ public class ArrivalProcessOpenDis7 extends SimEntityBase {
}
/**
+ * accessor method to set a state variable
* @param interarrivalTimeGenerator the interarrivalTimeGenerator to set
*/
public void setInterarrivalTimeGenerator(RandomVariate interarrivalTimeGenerator) {
@@ -112,6 +114,7 @@ public class ArrivalProcessOpenDis7 extends SimEntityBase {
}
/**
+ * accessor method to get a state variable
* @return the numberArrivals
*/
public int getNumberArrivals() {
@@ -119,6 +122,7 @@ public class ArrivalProcessOpenDis7 extends SimEntityBase {
}
/**
+ * accessor method to get current DIS channel object
* @return the disChannel
*/
public DisChannel getDisChannel() {
diff --git a/examples/src/SimkitOpenDis7Examples/Ship.java b/examples/src/SimkitOpenDis7Examples/Ship.java
index bc5eed407abb3b4d91fbe9390b8d29fd2699431b..aa46b4ca887a0452d52e0757bdf579c65b48db9c 100644
--- a/examples/src/SimkitOpenDis7Examples/Ship.java
+++ b/examples/src/SimkitOpenDis7Examples/Ship.java
@@ -3,7 +3,8 @@ package SimkitOpenDis7Examples;
import simkit.Entity;
/**
- * @author ahbuss
+ * Model a ship that arrives at a pier for crane servicing
+ * @author abuss@nps.edu
*/
public class Ship extends Entity {
@@ -13,7 +14,7 @@ public class Ship extends Entity {
protected double remainingUnloadingTime;
/**
- *
+ * Model constructor
* @throws IllegalArgumentException if remainingUnloadingTime ≤ 0.0
* @param remainingUnloadingTime Given initial unloading time
*/
@@ -37,7 +38,7 @@ public class Ship extends Entity {
}
/**
- *
+ * accessor method to get a state variable
* @return The remainingUnloadingTime
*/
public double getRemainingUnloadingTime() {
diff --git a/examples/src/SimkitOpenDis7Examples/ShipArrivalProcess.java b/examples/src/SimkitOpenDis7Examples/ShipArrivalProcess.java
index 60afbea0660be29a08de3edd5757202964e3e7c6..209bab376d71be17596bba00fe71dbc11f3c3f58 100644
--- a/examples/src/SimkitOpenDis7Examples/ShipArrivalProcess.java
+++ b/examples/src/SimkitOpenDis7Examples/ShipArrivalProcess.java
@@ -3,7 +3,8 @@ package SimkitOpenDis7Examples;
import simkit.random.RandomVariate;
/**
- * @author ahbuss
+ * Model a ship arrival process
+ * @author abuss@nps.edu
*/
public class ShipArrivalProcess extends ArrivalProcess {
@@ -19,7 +20,7 @@ public class ShipArrivalProcess extends ArrivalProcess {
}
/**
- *
+ * Instance constructor
* @param interarrivalTimeGenerator Given generator for interarrival times
* @param unloadTimeGenerator Given generator for total unloading times
*/
@@ -42,6 +43,7 @@ public class ShipArrivalProcess extends ArrivalProcess {
}
/**
+ * accessor method to get a state variable
* @return the unloadTimeGenerator
*/
public RandomVariate getUnloadTimeGenerator() {
@@ -49,6 +51,7 @@ public class ShipArrivalProcess extends ArrivalProcess {
}
/**
+ * accessor method to set a state variable
* @param unloadTimeGenerator the unloadTimeGenerator to set
*/
public void setUnloadTimeGenerator(RandomVariate unloadTimeGenerator) {
diff --git a/examples/src/SimkitOpenDis7Examples/SimpleServer.java b/examples/src/SimkitOpenDis7Examples/SimpleServer.java
index 506cf2acab122aff886206059227d9a6ae1bd160..5afa8dc658f80996cb82b19cf875fddf4f1a17f5 100644
--- a/examples/src/SimkitOpenDis7Examples/SimpleServer.java
+++ b/examples/src/SimkitOpenDis7Examples/SimpleServer.java
@@ -13,7 +13,7 @@ import simkit.random.RandomVariate;
* will occur ahead of any simultaneously scheduled Arrival events, as long as
* they have the default priority of 0.0.
*
- * @author ahbuss
+ * @author abuss@nps.edu
*/
public class SimpleServer extends SimEntityBase {
@@ -132,7 +132,7 @@ public class SimpleServer extends SimEntityBase {
}
/**
- *
+ * accessor method to get a state variable
* @return the numberAvailableServers
*/
public int getNumberAvailableServers() {
@@ -140,7 +140,7 @@ public class SimpleServer extends SimEntityBase {
}
/**
- *
+ * accessor method to get a state variable
* @return the numberInQueue
*/
public int getNumberInQueue() {
@@ -148,7 +148,7 @@ public class SimpleServer extends SimEntityBase {
}
/**
- *
+ * accessor method to set a state variable
* @param totalNumberServers total number of servers
* @throws IllegalArgumentException if totalNumberServers < 0
*/
@@ -160,6 +160,7 @@ public class SimpleServer extends SimEntityBase {
}
/**
+ * accessor method to get a state variable
* @return the serviceTimeGenerator
*/
public RandomVariate getServiceTimeGenerator() {
@@ -167,6 +168,7 @@ public class SimpleServer extends SimEntityBase {
}
/**
+ * accessor method to set a state variable
* @param serviceTimeGenerator the serviceTimeGenerator to set
*/
public void setServiceTimeGenerator(RandomVariate serviceTimeGenerator) {
@@ -174,7 +176,7 @@ public class SimpleServer extends SimEntityBase {
}
/**
- *
+ * accessor method to get a state variable
* @return the totalNumberServers
*/
public int getTotalNumberServers() {
@@ -182,7 +184,7 @@ public class SimpleServer extends SimEntityBase {
}
/**
- *
+ * accessor method to get a state variable
* @return the numberServed
*/
public int getNumberServed() {
diff --git a/examples/src/SimkitOpenDis7Examples/TwoCraneBerths.java b/examples/src/SimkitOpenDis7Examples/TwoCraneBerths.java
index d42c2c3766593813df1a484de2d85b7a745c1703..f0555181469d0fbc8ff641b3164bfa85e72887aa 100644
--- a/examples/src/SimkitOpenDis7Examples/TwoCraneBerths.java
+++ b/examples/src/SimkitOpenDis7Examples/TwoCraneBerths.java
@@ -6,7 +6,8 @@ import simkit.Priority;
import simkit.SimEntityBase;
/**
- * @author ahbuss
+ * Model two crane berths
+ * @author abuss@nps.edu
*/
public class TwoCraneBerths extends SimEntityBase {
@@ -209,7 +210,7 @@ public class TwoCraneBerths extends SimEntityBase {
}
/**
- *
+ * Get tree of sorted Ship set queue
* @return Shallow copy of queue
*/
public SortedSet<Ship> getQueue() {
@@ -217,7 +218,7 @@ public class TwoCraneBerths extends SimEntityBase {
}
/**
- *
+ * Get tree of sorted Ship set berths
* @return Shallow copy of berth
*/
public SortedSet<Ship> getBerth() {
@@ -225,7 +226,7 @@ public class TwoCraneBerths extends SimEntityBase {
}
/**
- *
+ * accessor method to get a state variable
* @return The timeInSystem
*/
public double getTimeInSystem() {
@@ -233,7 +234,7 @@ public class TwoCraneBerths extends SimEntityBase {
}
/**
- *
+ * accessor method to get a state variable
* @return The delayInQueue
*/
public double getDelayInQueue() {
diff --git a/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsComputerAssignment05.docx b/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsComputerAssignment05.docx
deleted file mode 100644
index a91574dcc69242c82303703ba899025c83314656..0000000000000000000000000000000000000000
Binary files a/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsComputerAssignment05.docx and /dev/null differ
diff --git a/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java b/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java
index 256c4d73528a3253e89c1779632dea459225ea13..4c1a91a971d4c5e5cf24d879f7b47f2651e1d26f 100644
--- a/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java
+++ b/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java
@@ -6,7 +6,15 @@ import simkit.Priority;
import simkit.SimEntityBase;
/**
- * @author ahbuss
+ * Add DIS outputs to TwoCraneBerths simkit simulation
+ * @see TwoCraneBerths
+ * @see SimkitOpenDis7Examples.run.RunTwoCranesBerth
+ * @see SimkitOpenDis7Examples.run.RunTwoCranesBerthOpenDis7
+ * @see <a href="run/RunTwoCranesBerthOpenDis7Log.txt">RunTwoCranesBerthOpenDis7Log.txt</a>
+ * @see <a href="TwoCraneBerthsAssignment05.docx">TwoCraneBerthsAssignment05.docx</a>
+ * @see <a href="TwoCraneBerthsAssignment05Solution.docx">TwoCraneBerthsAssignment05Solution.docx</a>
+ * @author abuss@nps.edu@nps.edu
+ * @author brutzman@nps.edu
*/
public class TwoCraneBerthsOpenDis7 extends SimEntityBase {
@@ -209,7 +217,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase {
}
/**
- *
+ * Get tree of sorted Ship set queue
* @return Shallow copy of queue
*/
public SortedSet<Ship> getQueue() {
@@ -217,7 +225,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase {
}
/**
- *
+ * Get tree of sorted Ship set berths
* @return Shallow copy of berth
*/
public SortedSet<Ship> getBerth() {
@@ -225,7 +233,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase {
}
/**
- *
+ * accessor method to get a state variable
* @return The timeInSystem
*/
public double getTimeInSystem() {
@@ -233,7 +241,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase {
}
/**
- *
+ * accessor method to get a state variable
* @return The delayInQueue
*/
public double getDelayInQueue() {
diff --git a/examples/src/SimkitOpenDis7Examples/run/RunSimpleServer.java b/examples/src/SimkitOpenDis7Examples/run/RunSimpleServer.java
index 308bdb6ba071aa389649ed6829cb1daa98e5284b..18fcc6379328affa2abe8cfb7316224a596cef0b 100644
--- a/examples/src/SimkitOpenDis7Examples/run/RunSimpleServer.java
+++ b/examples/src/SimkitOpenDis7Examples/run/RunSimpleServer.java
@@ -9,6 +9,7 @@ import simkit.stat.SimpleStatsTimeVarying;
import simkit.util.SimplePropertyDumper;
/**
+ * Run a simple server problem and compute statistical measurement of results.
* <h2>Output:</h2><pre>
* ArrivalProcess.1
* interarrivalTimeGenerator = Uniform (0.900, 2.200)
@@ -22,11 +23,17 @@ import simkit.util.SimplePropertyDumper;
* Average number in queue 15.9655
* Average utilization 0.9819</pre>
*
- * @author ahbuss
+ * @author abuss@nps.edu
*/
-public class RunSimpleServer {
-
+public class RunSimpleServer
+{
+ /** Default constructor */
+ public RunSimpleServer()
+ {
+ // default constructor
+ }
/**
+ * Run a simple program and compute statistical measurement of results.
* @param args the command line arguments
*/
public static void main(String args[]) {
diff --git a/examples/src/SimkitOpenDis7Examples/run/RunSimpleServerOpenDis7.java b/examples/src/SimkitOpenDis7Examples/run/RunSimpleServerOpenDis7.java
index 9c9acc52a9a4eb6ad862e1fd63b4ef50e3728c00..b4b9121931c1b2a2cb9376fda96344a56476cc63 100644
--- a/examples/src/SimkitOpenDis7Examples/run/RunSimpleServerOpenDis7.java
+++ b/examples/src/SimkitOpenDis7Examples/run/RunSimpleServerOpenDis7.java
@@ -27,13 +27,22 @@ import simkit.util.SimplePropertyDumper;
*
* @see SimkitOpenDis7Examples.ArrivalProcessOpenDis7
* @see SimkitOpenDis7Examples.SimpleServer
+ * @see <a href="RunSimpleServerOpenDis7Log.txt">RunSimpleServerOpenDis7Log.txt</a>
+ * @see <a href="../ArrivalProcessOpenDis7EventGraphPdu.png">ArrivalProcessOpenDis7EventGraphPdu.png</a>
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/raw/master/examples/src/SimkitOpenDis7Examples/documentation/ArrivalProcessDisPdu.png">ArrivalProcessDisPdu.png</a>
- * @author ahbuss
- * @author brutzman
+ * @author abuss@nps.edu@nps.edu
+ * @author brutzman@nps.edu
*/
-public class RunSimpleServerOpenDis7 {
-
+public class RunSimpleServerOpenDis7
+{
+ /** Default constructor */
+ public RunSimpleServerOpenDis7()
+ {
+ // default constructor
+ }
/**
+ * Run a simple program and compute statistical measurement of results.
+ * @see RunSimpleServer
* @param args the command line arguments
*/
public static void main(String args[]) {
diff --git a/examples/src/SimkitOpenDis7Examples/run/RunTwoCranesBerth.java b/examples/src/SimkitOpenDis7Examples/run/RunTwoCranesBerth.java
index c1cc922be6629c7141cb5fc356b7b30b150b9aba..ba18b328370c4e2751306f05a6dcd01e19e73e79 100644
--- a/examples/src/SimkitOpenDis7Examples/run/RunTwoCranesBerth.java
+++ b/examples/src/SimkitOpenDis7Examples/run/RunTwoCranesBerth.java
@@ -27,11 +27,17 @@ Average time in system: 1.3207
Average delay in queue: 0.4857
</pre>
*
- * @author ahbuss
+ * @author abuss@nps.edu
*/
-public class RunTwoCranesBerth {
-
+public class RunTwoCranesBerth
+{
+ /** Default constructor */
+ public RunTwoCranesBerth()
+ {
+ // default constructor
+ }
/**
+ * Run a simple program and compute statistical measurement of results.
* @param args the command line arguments
*/
public static void main(String[] args) {
diff --git a/examples/src/SimkitOpenDis7Examples/run/RunTwoCranesBerthOpenDis7.java b/examples/src/SimkitOpenDis7Examples/run/RunTwoCranesBerthOpenDis7.java
index 4c095942ba17feb96a2db80b528e6fa6be526c17..c04cec170340250ec083bf0c51e019f5a0024fa1 100644
--- a/examples/src/SimkitOpenDis7Examples/run/RunTwoCranesBerthOpenDis7.java
+++ b/examples/src/SimkitOpenDis7Examples/run/RunTwoCranesBerthOpenDis7.java
@@ -27,11 +27,17 @@ Average time in system: 1.3207
Average delay in queue: 0.4857
</pre>
*
- * @author ahbuss
+ * @author abuss@nps.edu
*/
-public class RunTwoCranesBerthOpenDis7 {
-
+public class RunTwoCranesBerthOpenDis7
+{
+ /** Default constructor */
+ public RunTwoCranesBerthOpenDis7()
+ {
+ // default constructor
+ }
/**
+ * Run a simple program and compute statistical measurement of results.
* @param args the command line arguments
*/
public static void main(String[] args) {