Changeset 233 in tmcsimulator for branches/FEPSimulator/HighwaysParser.cpp

Timestamp:

11/13/2017 06:07:07 PM (8 years ago)

Author:

jtorres

Message:

FEPSim: finalized comments, added to both header and source files.

File:

• branches/FEPSimulator/HighwaysParser.cpp (modified) (6 diffs)

branches/FEPSimulator/HighwaysParser.cpp

@@ -1 +1 @@
 /* 
- * File:   HighwaysParser.cpp
- * Author: jtorres
+ * File:   HighwaysParser.h
  * 
- * Created on October 28, 2017, 7:23 PM
+ * The HighwaysParser class takes in a character buffer and parses it into a 
+ * vector of FEP_LINEs and a vector of STATIONS. The buffer is sent in via the
+ * constructor and the FEP_LINE and STATION vectors are accessible via public
+ * members.
+ * 
+ * @author John A. Torres
  */
 
 #include "HighwaysParser.h"
-     /* 43                   // "number of lines"
-     * 32 0 13              // "line id" "count num" "number of stations"
-     * 1210831 1 5 S 0.9 8  // "station id" "drop num" "route num"...
-     *                      //      ..."direction" "postmile" "number of loops"
-     * 1210832  0.0 0       // "loop id" "occ" "vol"
-     * 1210833  0.0 0       // ..
-     * 1210834  0.0 0       // ..
-     * 1210835  0.0 0       // ..
-     * 1210836  0.0 0       // ..
-     * 1210837  0.0 0       // ..
-     * 1210838  0.0 0       // ..
-     * 1210839  0.0 0       // ..
-      * */
+
+// The public stations member, containing the parsed vector of STATIONS
 HighwaysParser::HighwaysParser(char * hwyData) {
     parseLines(hwyData);
 }
 
+// Frees all allocated memory in the class
 HighwaysParser::~HighwaysParser() {
     // deallocate FEPLines
@@ -48 +42 @@
 }
 
+/**
+ * Parses the buffer into FEP_LINE and STATION vectors.
+ * 
+ * @param highwaysData buffer
+ */
 void HighwaysParser::parseLines(char * hwyData)
 {
+    // convert buffer to cpp string type
     string highwaysData = hwyData;
+    // create buffer stream
     istringstream highwaysStream(highwaysData);
+    // get the number of FEPLines
     string currLine;
     getline(highwaysStream, currLine);
     int numLines;
     sscanf(currLine.c_str(), "%d", &numLines);
+    
+    // declare variables used in parsing lines and stations
     int lineNum = 0;
     long lds = 0;
@@ -72 +76 @@
     int vol = 0;
 
+    // for each line
     for(int lineIndex = 0; lineIndex < numLines; lineIndex++)
     {
@@ -87 +92 @@
         newLine->schedleSeq = schedleSeq;
         
+        // for each station
         for(int stationIndex = 0; stationIndex < numStations; stationIndex++)
         {
@@ -104 +110 @@
             newStation->MlTotVol = 0;
             newStation->OppTotVol = 0;
-            
+            // for each loop
             for(int loopIndex = 0; loopIndex < numLoops; loopIndex++)
             {
@@ -121 +127 @@
             newStation->dataPack = DataPacker::packData(newStation);
             
+            // add new station to stations vector
             this->stations.push_back(newStation);
         }
+        // add new line to lines vector
         this->lines.push_back(newLine);
     }