Changeset 274 in tmcsimulator for trunk/src/atmsdriver

Timestamp:

02/25/2019 04:36:04 PM (7 years ago)

Author:

jdalbey

Message:

Multi file commit: adding and elaborating on comments and javadoc.

Location:

trunk/src/atmsdriver/model

Files:

• Highways.java (modified) (10 diffs)
• PostmileCoords.java (modified) (1 diff)
• Station.java (modified) (2 diffs)

trunk/src/atmsdriver/model/Highways.java

@@ -63 +63 @@
         // load FEP Lines
         lines = loadLines(highwaysMapFileName);
-        // configure and load highways
-        this.highways = configureHighways();
+        // build highways data structure
+        this.highways = buildHighways();
 
         // write to FEP host and port number
@@ -71 +71 @@
     }
 
-    private ArrayList<Highway> configureHighways()
-    {
-        System.out.println("Loading highways...");
+    private ArrayList<Highway> buildHighways()
+    {
+        System.out.println("Building highways...");
         // The list of highways to return
         ArrayList<Highway> highways = new ArrayList<Highway>();
@@ -89 +89 @@
             {
                 Integer hwyNum = station.routeNumber;
-                
                 // if the map does not contain an entry for the highway, create
                 // a new entry (key/value pair) for the highway and instantiate
@@ -116 +115 @@
             ArrayList<Station> hwyStations = highwayMap.get(hwyKey);
             Collections.sort(hwyStations);
-            System.out.println("Loaded highway " + hwyKey + "...");
+            System.out.println("Loaded highway " + hwyKey + " with " +
+                    hwyStations.size() + " stations.");
             highways.add(new Highway(hwyKey,
                     hwyStations));
@@ -159 +159 @@
             startPost = postmile;
             endPost = postmile + range;
-
+            //TODO: Catch NPE exception for situation when the events file 
+            //   specifies a highway that doesn't exist in the network.
+            //   Also the case where a desired postmile to color isn't in
+            //   the network.
             // iterate through the stations, if within the specified highway
             // stretch, update the station by direction and apply dot color
@@ -222 +225 @@
     
     /**
-     * Loads a single FEP Line from the highways map file.
+     * Load all the stations for a single FEP Line from the highways map file.
      * 
      * @param sc scanner at the current FEPLine line
@@ -348 +351 @@
             // Print the number of bytes the highways data message contains
             System.out.println("Highways sending " + this.toCondensedFormat(false).toCharArray().length + 1 + "bytes to FEPSIM.");
-            
+            String outMsg = this.toCondensedFormat(false);
             // Write the highways data over the socket
-            out.println(this.toCondensedFormat(false));
+            out.println(outMsg);
             
             // close the socket
@@ -371 +374 @@
      *  and does include the string location names. If MetaDataOnly is false,
      *  dynamic loop values are included, and unnecessary information like string
-     *  location values are included.
+     *  location values are not included.
      * 
      *  The FEPSimulator takes in the toCondensedFormat() output, with a MetaDataOnly
@@ -526 +529 @@
     public String toJson()
     {
+        // TODO: move loading this file to init method so it doesn't get 
+        // called every time.
         PostmileCoords pmList = new PostmileCoords();
         FileInputStream fis = null;
@@ -545 +550 @@
         for (Highway hwy: highways)
         {
-            // For json output we don't care about listing all the stations
-            // in order by direction because we are just outputting points not lines.
+            // Consider each route direction
+            for (DIRECTION dir: DIRECTION.values())
             {
                 // Examine every station on this highway and direction

trunk/src/atmsdriver/model/PostmileCoords.java

@@ -119 +119 @@
         public boolean nameEquals(String target)
         {
+            // remove .0 for comparing strings
+            if (target.endsWith(".0"))
+            {
+                String truncTarget = target.substring(0,target.length()-2);
+                return this.name.equals(truncTarget);
+            }
             return this.name.equals(target);
         }

trunk/src/atmsdriver/model/Station.java

@@ -208 +208 @@
     {
         /* For now just use the color of the first lane. 
-         * TODO: Average the color in all the lanes for the given direction */
+         * TODO: Average the color in ALL the lanes for the given direction */
 
         String laneDir = "";
@@ -219 +219 @@
             laneDir = "OS";
         }
-        // Examine all the lanes in a given direction
+        // Search lanes to find specified direction
         for (LoopDetector loop : loops)
         {
             if (loop.loopLocation.substring(0,2).equals(laneDir))
             {
-                // Return color according to loop volume
+                // Return color according to loop volume of first matching lane
                 if (loop.vol == 1)
                 {