Revize 734533a8

re #8597 Code maintenance - comments, namespace changes

Server/ServerApp/Parser/Parsers/JisParser.cs

@@ -1 @@
-using Parser.OutputInfo;
-using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
-using Parser.InputData;
+using ServerApp.Parser.InputData;
+using ServerApp.Parser.OutputInfo;
 
-namespace Parser.Parsers
+namespace ServerApp.Parser.Parsers
 {
+    /// <summary>
+    /// Class parsing jis files into instances of ActivityInfo divided by given time interval
+    /// Data parsed from 7am (included) to 18pm (included)
+    /// </summary>
     class JisParser
     {
-
-        public List<JisInfo> ParseJisData(string folder, bool wholeDay = true, int interval = 1)
+        
+        /// <summary>
+        /// Parses jis data to ActivityInfo instances
+        /// Data parsed from 7am (included) to 18pm (included)
+        /// </summary>
+        /// <param name="folder">Folder with login data files</param>
+        /// <param name="wholeDay">Should data be parsed as one instance per day (if true parameter interval will be ignored)</param>
+        /// <param name="interval">Time interval to divide days by, minimum is 1h</param>
+        /// <returns></returns>
+        public List<ActivityInfo> ParseJisData(string folder, bool wholeDay = true, int interval = 1)
         {
-            List<JisInfo> list = new List<JisInfo>();
-
-            // najít složku, ve složce sou data co se budou parsovat
-
             if (!Directory.Exists(folder))
                 return null;
 
-            // když v jednej složce budou všechny jis data co chci zpracovat
-            // pro každej soubor budu spouštět parsování
+            List<ActivityInfo> list = new List<ActivityInfo>();
+
+            // parse all files
             string[] fileEntries = Directory.GetFiles(folder);
             foreach (string fileName in fileEntries)
             {
-                List<JisInfo> loadedData = null;
-                // pokud po jednom dni
+                List<ActivityInfo> loadedData = null;
+
+                // parse as one instance per day
                 if (wholeDay)
                     loadedData = ProcessOneJisFileAsDays(fileName);
-                // pokud po hodinách
+                // parse by interval length
                 else
                 {
                     // pokud: konec dne nebo konec aktuálního intervalu -> vemu to co sem nasčítal
@@ -40 +50 @@
             return list;
         }
 
-        private static List<JisInfo> ProcessOneJisFileAsDays(string path)
+        /// <summary>
+        /// Parses data from one data file as one instance per day
+        /// </summary>
+        /// <param name="path">Path ti file</param>
+        /// <returns>List with ActivityInfo instances</returns>
+        private static List<ActivityInfo> ProcessOneJisFileAsDays(string path)
         {
-            List<JisInfo> jisInfo = new List<JisInfo>();
+            if (!File.Exists(path))
+                return null;
 
-            // načíst data ze souboru
+            List<ActivityInfo> jisInfo = new List<ActivityInfo>();
             List<JisInstance> list =  CsvDataLoader.LoadJisFile(path);
 
+            // data for each faculty
             int[] recordedAmount = new int[TagInfo.faculties.Length];
+            // min/max hour taken into account
             int[] minmaxHour = new int[] { 7, 18 };
+            // interval length
             int range = minmaxHour[1] - minmaxHour[0];
 
-            // procházet data ze souboru
-            DateTime lastStartTime = new DateTime(list[0].dateTime.Year, list[0].dateTime.Month, list[0].dateTime.Day);
+            // first day
+            DateTime lastStartTime = new DateTime(list[0].dateTime.Year, list[0].dateTime.Month, list[0].dateTime.Day, minmaxHour[0], 0, 0);
             for (int i = 0; i < list.Count; i++)
             {
                 int currHour = list[i].dateTime.Hour;
                 if (currHour < minmaxHour[0] || currHour > minmaxHour[1])
                     continue;
 
-                // v každym dni agreguju
+                // start of the day -> make an instance
                 string place = list[i].placeTag;
-                DateTime date = new DateTime(list[i].dateTime.Year, list[i].dateTime.Month, list[i].dateTime.Day);
+                DateTime date = new DateTime(list[i].dateTime.Year, list[i].dateTime.Month, list[i].dateTime.Day, minmaxHour[0], 0, 0);
                 if (!date.Equals(lastStartTime)) 
                 {
+                    // data for each faculty separate
                     for (int k = 0; k < TagInfo.faculties.Length; k++)
                     {
-                        JisInfo dayInfo = new JisInfo(TagInfo.faculties[k], recordedAmount[k], lastStartTime, range);
+                        ActivityInfo dayInfo = new ActivityInfo(TagInfo.faculties[k], recordedAmount[k], lastStartTime, range);
                         jisInfo.Add(dayInfo);
                     }
 
@@ -74 +94 @@
                     lastStartTime = date;
                 }
 
-                // tady nasčítávát podle místa
+                // aggregate data
                 if (TagInfo.jisPlaces.ContainsKey(place))
                 {
                     int index = TagInfo.jisPlaces[place];
@@ -87 +107 @@
                 }
                 else
                 {
+                    // TODO uknown code handling
                     Console.WriteLine("Unknown code " + list[i].placeTag);
                 }
 
             }
 
+            // last day
             for (int k = 0; k < TagInfo.faculties.Length; k++)
             {
-                JisInfo dayInfo = new JisInfo(TagInfo.faculties[k], recordedAmount[k], lastStartTime, range);
+                ActivityInfo dayInfo = new ActivityInfo(TagInfo.faculties[k], recordedAmount[k], lastStartTime, range);
                 jisInfo.Add(dayInfo);
             }
 
             return jisInfo;
         }
 
-        private static List<JisInfo> ProcessOneJisFileAsIntervals(string path, int interval)
+        private static List<ActivityInfo> ProcessOneJisFileAsIntervals(string path, int interval)
         {
             throw new NotImplementedException();
         }