From 62edda024ba3b660618a231b60b5ea4a83c7b64e Mon Sep 17 00:00:00 2001
From: brutzman <brutzman@nps.edu>
Date: Sun, 14 May 2023 21:25:34 -0700
Subject: [PATCH] touchups for clarity

---
 .../src/SimkitOpenDis7Examples/TwoCraneBerths.java     | 10 ++++++----
 .../SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java |  6 +++---
 .../run/RunTwoCraneBerthsOpenDis7.java                 |  2 +-
 3 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/examples/src/SimkitOpenDis7Examples/TwoCraneBerths.java b/examples/src/SimkitOpenDis7Examples/TwoCraneBerths.java
index f055518146..a106415442 100644
--- a/examples/src/SimkitOpenDis7Examples/TwoCraneBerths.java
+++ b/examples/src/SimkitOpenDis7Examples/TwoCraneBerths.java
@@ -9,7 +9,8 @@ import simkit.SimEntityBase;
  * Model two crane berths
  * @author abuss@nps.edu
  */
-public class TwoCraneBerths extends SimEntityBase {
+public class TwoCraneBerths extends SimEntityBase
+{
 
     /**
      * Queue of Ships waiting to go into the berth
@@ -47,14 +48,15 @@ public class TwoCraneBerths extends SimEntityBase {
         super.reset();
         queue.clear();
         berth.clear();
-        timeInSystem = Double.NaN;
-        delayInQueue = Double.NaN;
+        timeInSystem = Double.NaN; // Not a Number
+        delayInQueue = Double.NaN; // Not a Number
     }
 
     /**
      * Only PropertyChangeEvents
      */
-    public void doRun() {
+    public void doRun() 
+    {
         firePropertyChange("queue", getQueue());
         firePropertyChange("berth", getBerth());
         firePropertyChange("timeInSystem", getTimeInSystem());
diff --git a/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java b/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java
index 6482e6ef27..26a48ac161 100644
--- a/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java
+++ b/examples/src/SimkitOpenDis7Examples/TwoCraneBerthsOpenDis7.java
@@ -183,7 +183,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase
      */
     public void doStartUnloadingOneCrane() {
         SortedSet<Ship> oldQueue = getQueue();
-        Ship ship = queue.first(); // TODO rename ship queue
+        Ship ship = queue.first();
         queue.remove(ship);
         firePropertyChange("queue", oldQueue, getQueue());
 
@@ -196,6 +196,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase
         berth.add(ship);
         firePropertyChange("berth", oldBerth, getBerth());
         
+        // log crane operations for each ship
         shipCount++;
         
         if (shipCount == 1)
@@ -212,7 +213,6 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase
         waitDelay("EndUnloadingOneCrane", ship.getRemainingUnloadingTime(), ship);
     }
     
-        
     /**
      * Perform crane container unloading operations and send PDUs to report progress
      * @param simkitTimeStamp  simkit timeStamp when crane operations began
@@ -324,7 +324,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase
     /**
      * Shutdown DIS network interfaces, enabling program termination
      */
-    public void shutdown()
+    public void shutdownDisChannel()
     {
         if (disChannel != null)
         {
diff --git a/examples/src/SimkitOpenDis7Examples/run/RunTwoCraneBerthsOpenDis7.java b/examples/src/SimkitOpenDis7Examples/run/RunTwoCraneBerthsOpenDis7.java
index e579782fc3..33c69a794c 100644
--- a/examples/src/SimkitOpenDis7Examples/run/RunTwoCraneBerthsOpenDis7.java
+++ b/examples/src/SimkitOpenDis7Examples/run/RunTwoCraneBerthsOpenDis7.java
@@ -91,7 +91,7 @@ public class RunTwoCraneBerthsOpenDis7
         System.out.printf("Average delay in queue:\t\t%.4f%n",
                 delayInQueueStat.getMean());    
     
-        twoCraneBerthsOpenDis7.shutdown();
+        twoCraneBerthsOpenDis7.shutdownDisChannel();
         System.exit(0);
     }
 }
-- 
GitLab