Changeset 86 in tmcsimulator for branches/FEPSimulator/NetworkReader.h

Timestamp:

10/09/2017 11:58:19 PM (9 years ago)

Author:

jtorres

Message:

branches/FEPSimulator: updated and improved comments, added Main.cpp which creates the FEPSimulator, minor project configurations (runtime command line arguments / tinyxml.a libosxtinyxml.a)

File:

• branches/FEPSimulator/NetworkReader.h (modified) (1 diff)

branches/FEPSimulator/NetworkReader.h

@@ -58 +58 @@
 #include "DataPacker.h"
 
-class NetworkReader
-{
-    public:
-        NetworkReader(const char * networkFile); // Constructor
-        ~NetworkReader(); // Destructor
-        
-        vector<FEP_LINE*> getLines(); // Getter for FEP_LINE list
-        vector<STATION*> getStations(); // Getter for STATION list
-    private:
-        vector<FEP_LINE*> lines;
-        vector<STATION*> stations;
-        int ldsIndex;
-
-        void loadLines(const char * networkFileName);
-        LOOP * parseLoop(TiXmlElement * loopElem);
-        STATION * parseStation(TiXmlElement *stationElem, FEP_LINE *line);
-        FEP_LINE * parseLine(TiXmlElement *lineElem);
+class NetworkReader {
+public:
+    /**
+     * Constructor
+     * @param xml Highway Status XML data
+     */
+    NetworkReader(const char * xml);
+    
+    /**
+     * Destructor: no cleaning necessary
+     */
+    ~NetworkReader();
+    
+    /**
+     * Returns FEP_LINE list.
+     * 
+     * @return List of FEP_LINES
+     */
+    vector<FEP_LINE*> getLines();
+    
+    /**
+     * Returns STATIONS list.
+     * @return List of STATIONs
+     */
+    vector<STATION*> getStations();
+    
+private:
+    vector<FEP_LINE*> lines;
+    vector<STATION*> stations;
+    int ldsIndex;
+    
+    /**
+     * Loads Highway Status data from xml.
+     * 
+     * @param xml Highway Status XML.
+     */
+    void loadLines(const char * networkFileName);
+    
+    /**
+     * Parses a single LOOP
+     * @param loopElem TinyXML loop elem
+     * @return LOOP
+     */
+    LOOP * parseLoop(TiXmlElement * loopElem);
+    
+    /**
+     * Parses a single STATION
+     * 
+     * @param TinyXML station element
+     * @param the parent FEP_LINE
+     * @return STATION
+     */
+    STATION * parseStation(TiXmlElement *stationElem, FEP_LINE *line);
+    
+    /**
+     * Parses a single FEP_LINE
+     * @param TinyXML line element
+     * @return FEP_LINE
+     */
+    FEP_LINE * parseLine(TiXmlElement *lineElem);
 };