Docs

Author: Grufoony

src/dsf/mobility/RoadNetwork.hpp

@@ -190,7 +190,8 @@ namespace dsf::mobility {
       requires is_street_v<std::remove_reference_t<T1>> &&
                (is_street_v<std::remove_reference_t<Tn>> && ...)
     void addStreets(T1&& street, Tn&&... streets);
-
+    /// @brief Set the streets' stationary weights
+    /// @param streetWeights A map where the key is the street id and the value is the street stationary weight. If a street id is not present in the map, its stationary weight is set to 1.0.
     void setStreetStationaryWeights(std::unordered_map<Id, double> const& streetWeights);
 
     /// @brief Get a street from the graph

src/dsf/mobility/Street.hpp

@@ -86,7 +86,10 @@ namespace dsf::mobility {
     static void setMeanVehicleLength(double meanVehicleLength);
     /// @brief Set the street's stationary weight
     /// @param weight The street's stationary weight
-    inline void setStationaryWeight(double const weight) { m_stationaryWeight = weight; }
+    inline void setStationaryWeight(double const weight) {
+      weight > 0. ? m_stationaryWeight = weight
+                  : throw std::invalid_argument("Stationary weight must be positive");
+    }
     /// @brief Enable a coil (dsf::Counter sensor) on the street
     /// @param name The name of the counter (default is "Coil_<street_id>")
     void enableCounter(std::string name = std::string());