Merge branch 'dev' of https://github.com/KarmaKamikaze/FCDS into dev

KarmaKamikaze · May 21, 2021 · 152bcdc · 152bcdc
2 parents 764bc91 + 7068041
commit 152bcdc
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/node/PublicResources/js/graphHelper.js b/node/PublicResources/js/graphHelper.js
@@ -58,6 +58,9 @@ class CyGraph {
   idleZones = new Array();
   obstructions = new Array();
 
+  /**
+   * Resets the simulation stats, allowing for a simulation restart
+   */
   reset() {
     this.courierCount = 0;
     this.simulationStats = new SimStats();

diff --git a/node/PublicResources/js/orderGeneration.js b/node/PublicResources/js/orderGeneration.js
@@ -334,6 +334,10 @@ function findCourier(cyGraph, order) {
   return bestCourier;
 }
 
+/**
+ * Stops the simulation, logging stats in the console.
+ * @param {Class} cyGraph The simulation object.
+ */
 function stopSimulation(cyGraph) {
   clearInterval(cyGraph.simHandler);
   console.log(
@@ -364,6 +368,10 @@ function stopSimulation(cyGraph) {
   );
 }
 
+/**
+ * Restarts the simulation, allowing for endless loops of a certain amount of simulation days.
+ * @param {Class} cyGraph The simulation object.
+ */
 function restartSimulation(cyGraph) {
   cyGraph.numSimulations++;
   cyGraph.reset();