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

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.h (modified) (2 diffs)

branches/FEPSimulator/HighwaysParser.h

@@ -1 +1 @@
 /* 
  * File:   HighwaysParser.h
- * Author: jtorres
- *
- * 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
  */
 
@@ -18 +22 @@
 class HighwaysParser {
 public:
+    /**
+     * Constructor. Takes in the character buffer to be parsed.
+     * 
+     * @param highwaysData buffer
+     */
     HighwaysParser(char * highwaysData);
+    /**
+     * Parses the buffer into FEP_LINE and STATION vectors.
+     * 
+     * @param highwaysData buffer
+     */
     void parseLines(char * highwaysData);
+    // The public lines member, containing the parsed vector of FEP_LINES
     vector<FEP_LINE*> lines;
+    // The public stations member, containing the parsed vector of STATIONS
     vector<STATION*> stations;
+    // Frees all allocated memory in the class
     virtual ~HighwaysParser();
 private: