Added some Documentation

Simulation.cpp

@@ -546,7 +546,8 @@ double Simulation::RunBody(double maxSimTime)
                 }
             }
 
-            if (_routingEngine->isNeedUpdate()){
+            // here the used routers are update, when needed due to external changes
+            if (_routingEngine->NeedsUpdate()){
                  _routingEngine->UpdateRouter();
             }
 

routing/Router.h

@@ -142,6 +142,10 @@ public:
 
      void SetTrips(const Trips& trips);
 
+     /**
+      * Update the router, when geometry changed due to external changes.
+      * Remark: Depends on router if needed!
+      */
      virtual void Update();
 };
 

routing/RoutingEngine.cpp

@@ -131,7 +131,7 @@ bool RoutingEngine::Init(Building* building)
      return status;
 }
 
-bool RoutingEngine::isNeedUpdate() const
+bool RoutingEngine::NeedsUpdate() const
 {
      return _needUpdate;
 }

routing/RoutingEngine.h

@@ -107,6 +107,22 @@ public:
       */
      bool Init(Building* building);
 
+     /**
+      * Returns if routers need to be updated
+      * @return routers need to be updated
+      */
+     bool NeedsUpdate() const;
+
+     /**
+      * Set if routers need to be updated
+      * @param needUpdate
+      */
+     void setNeedUpdate(bool needUpdate);
+
+     /**
+      * Updates all used routers
+      */
+     void UpdateRouter();
 
 private:
      /// collections of all routers used
@@ -114,12 +130,6 @@ private:
      /// collection of all trips/routes
      Trips _tripsCollection;
      bool _needUpdate = false;
-public:
-    bool isNeedUpdate() const;
-
-    void setNeedUpdate(bool needUpdate);
-
-    void UpdateRouter();
 };
 
 #endif /* ROUTINGENGINE_H_ */