From 8958ae7fc3046197d268b0b6ba25cb0568ebb721 Mon Sep 17 00:00:00 2001
From: jonathanboron <jonathanboron@172.20.148.95>
Date: Mon, 2 Sep 2019 18:04:11 -0700
Subject: [PATCH] HW4 update 2, javadocs added

---
 .../homework4/Boron/BoronEntityStatePduCreator.java  |  9 +++++++++
 .../homework4/Boron/BoronPduSender.java              | 12 ++++++++++--
 2 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/assignments/src/MV3500Cohort2019JulySeptember/homework4/Boron/BoronEntityStatePduCreator.java b/assignments/src/MV3500Cohort2019JulySeptember/homework4/Boron/BoronEntityStatePduCreator.java
index 573cf30948..855dd84aa1 100644
--- a/assignments/src/MV3500Cohort2019JulySeptember/homework4/Boron/BoronEntityStatePduCreator.java
+++ b/assignments/src/MV3500Cohort2019JulySeptember/homework4/Boron/BoronEntityStatePduCreator.java
@@ -15,6 +15,15 @@ public class BoronEntityStatePduCreator {
      */
     public BoronEntityStatePduCreator(){}
     
+    /**
+     * Creates and returns a new Entity State PDU
+     * @param s is a 16 bit ID
+     * @param fid is a force ID enumeration
+     * @param l is a double array containing position x,y,z coordinates
+     * @param v is a float array containing x,y,z velocity values
+     * @param o is a float array containing phi, psi, and theta orientation values
+     * @returns a new EntityStatePdu with minimal information
+     */
     public EntityStatePdu newPDU(short s, ForceID fid, double [] l, float[] v, float[] o)
     {
         //Create new entity state PDU and set ID and Force ID
diff --git a/assignments/src/MV3500Cohort2019JulySeptember/homework4/Boron/BoronPduSender.java b/assignments/src/MV3500Cohort2019JulySeptember/homework4/Boron/BoronPduSender.java
index c37d6158e5..aaef02d78c 100644
--- a/assignments/src/MV3500Cohort2019JulySeptember/homework4/Boron/BoronPduSender.java
+++ b/assignments/src/MV3500Cohort2019JulySeptember/homework4/Boron/BoronPduSender.java
@@ -95,21 +95,27 @@ public class BoronPduSender
         
         for (int i = 0; i < 3; i++)
         {
-            
+            //For demonstration purposes, ID is a random short. A larger program would
+            //have a more elaborate ID assignment system to prevent duplication.
             short id = (short)rand.nextInt(10000);
             
+            //Generate random x,y,z coordinates between 0 and 10
             double[] l = new double[]
             {
                 rand.nextInt(10) + rand.nextDouble(), 
                 rand.nextInt(10) + rand.nextDouble(), 
                 rand.nextInt(10) + rand.nextDouble()
             };
+            
+            //Generate random velocity
             float[] v = new float[]
             {
                 rand.nextFloat(),
                 rand.nextFloat(),
                 rand.nextFloat()
             };
+            
+            //Generate random orientation
             float[] o = new float[]
             {
                 rand.nextFloat(), 
@@ -117,11 +123,13 @@ public class BoronPduSender
                 rand.nextFloat()
             };
             
+            //Add entity PDUs to the list to send out
             generatedPdusList.add(espduCreator.newPDU(id, ForceID.FRIENDLY, l, v, o));  
         }
         
         System.out.println("Send the " + generatedPdusList.size() + " PDUs we created...");
-            
+        
+        //Send the PDUs
         if (args.length == 2)
         {
             BoronPduSender sender = new BoronPduSender(Integer.parseInt(args[0]), args[1]);
-- 
GitLab