Skip to content

Commit ebeffba

Browse files
committed
Update docs
1 parent c404c4e commit ebeffba

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/dsf/mobility/RoadDynamics.hpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ namespace dsf::mobility {
191191
void resetTurnCounts();
192192

193193
/// @brief Update the paths of the itineraries based on the given weight function
194+
/// @param throw_on_empty If true, throws an exception if an itinerary has an empty path (default is true)
195+
/// If false, removes the itinerary with empty paths and the associated node from the origin/destination nodes
196+
/// @throws std::runtime_error if throw_on_empty is true and an itinerary has an empty path
194197
void updatePaths(bool const throw_on_empty = true);
195198
/// @brief Add agents uniformly on the road network
196199
/// @param nAgents The number of agents to add

0 commit comments

Comments
 (0)