![]() |
Eclipse SUMO - Simulation of Urban MObility
|
A device that performs vehicle rerouting based on current edge speeds. More...
#include <MSRoutingEngine.h>
Public Types | |
typedef RouterProvider< MSEdge, MSLane, MSJunction, SUMOVehicle > | MSRouterProvider |
Static Public Member Functions | |
static void | addEdgeTravelTime (const MSEdge &edge, const SUMOTime travelTime) |
record actual travel time for an edge | |
static void | cleanup () |
deletes the router instance | |
static double | getAssumedSpeed (const MSEdge *edge, const SUMOVehicle *veh) |
return current travel speed assumption | |
static ConstMSRoutePtr | getCachedRoute (const std::pair< const MSEdge *, const MSEdge * > &key) |
return the cached route or nullptr on miss | |
static double | getEffort (const MSEdge *const e, const SUMOVehicle *const v, double t) |
Returns the effort to pass an edge. | |
static double | getEffortBike (const MSEdge *const e, const SUMOVehicle *const v, double t) |
static double | getEffortExtra (const MSEdge *const e, const SUMOVehicle *const v, double t) |
static SUMOTime | getLastAdaptation () |
Information when the last edge weight adaptation occurred. | |
static SUMOAbstractRouter< MSEdge, SUMOVehicle > & | getRouterTT (const int rngIndex, SUMOVehicleClass svc, const MSEdgeVector &prohibited=MSEdgeVector()) |
return the router instance | |
static bool | hasEdgeUpdates () |
returns whether any edge weight updates will take place | |
static void | initEdgeWeights (SUMOVehicleClass svc) |
initialize the edge weights if not done before | |
static void | initRouter (SUMOVehicle *vehicle=nullptr) |
static void | initWeightUpdate () |
intialize period edge weight update | |
static bool | isEnabled () |
returns whether any routing actions take place | |
static void | reroute (SUMOVehicle &vehicle, const SUMOTime currentTime, const std::string &info, const bool onInit=false, const bool silent=false, const MSEdgeVector &prohibited=MSEdgeVector()) |
initiate the rerouting, create router / thread pool on first use | |
static void | setEdgeTravelTime (const MSEdge *const edge, const double travelTime) |
adapt the known travel time for an edge | |
static bool | withTaz () |
whether taz-routing is enabled | |
Static Public Attributes | |
static SUMOAbstractRouter< MSEdge, SUMOVehicle >::Operation | myEffortFunc = &MSRoutingEngine::getEffort |
Private Types | |
typedef std::pair< SUMOTime, int > | TimeAndCount |
Private Member Functions | |
MSRoutingEngine (const MSRoutingEngine &) | |
Invalidated copy constructor. | |
MSRoutingEngine & | operator= (const MSRoutingEngine &) |
Invalidated assignment operator. | |
Static Private Member Functions | |
static void | _initEdgeWeights (std::vector< double > &edgeSpeeds, std::vector< std::vector< double > > &pastEdgeSpeeds) |
initialized edge speed storage into the given containers | |
static SumoRNG * | getThreadRNG () |
returns RNG associated with the current thread | |
Network state adaptation | |
static SUMOTime | adaptEdgeEfforts (SUMOTime currentTime) |
Adapt edge efforts by the current edge states. | |
static double | patchSpeedForTurns (const MSEdge *edge, double currSpeed) |
Static Private Attributes | |
static SUMOTime | myAdaptationInterval = -1 |
At which time interval the edge weights get updated. | |
static int | myAdaptationSteps |
The number of steps for averaging edge speeds (ring-buffer) | |
static int | myAdaptationStepsIndex = 0 |
The current index in the pastEdgeSpeed ring-buffer. | |
static double | myAdaptationWeight |
Information which weight prior edge efforts have. | |
static bool | myBikeSpeeds |
whether separate speeds for bicycles shall be tracked | |
static std::map< std::pair< const MSEdge *, const MSEdge * >, ConstMSRoutePtr > | myCachedRoutes |
The container of pre-calculated routes. | |
static std::vector< double > | myEdgeBikeSpeeds |
static double | myEdgePriorityRange |
the difference between maximum and minimum priority for all edges | |
static std::vector< double > | myEdgeSpeeds |
The container of edge speeds. | |
static std::vector< TimeAndCount > | myEdgeTravelTimes |
Sum of travel times experienced by equipped vehicles for each edge. | |
static Command * | myEdgeWeightSettingCommand = nullptr |
The weights adaptation/overwriting command. | |
static SUMOTime | myLastAdaptation = -1 |
Information when the last edge weight adaptation occurred. | |
static double | myMinEdgePriority |
Minimum priority for all edges. | |
static std::vector< std::vector< double > > | myPastEdgeBikeSpeeds |
static std::vector< std::vector< double > > | myPastEdgeSpeeds |
The container of past edge speeds (when using a simple moving average) | |
static double | myPriorityFactor |
Coefficient for factoring edge priority into routing weight. | |
static MSRouterProvider * | myRouterProvider = nullptr |
The router to use. | |
static std::map< std::thread::id, SumoRNG * > | myThreadRNGs |
static bool | myWithTaz |
whether taz shall be used at initial rerouting | |
A device that performs vehicle rerouting based on current edge speeds.
The routing-device system consists of in-vehicle devices that perform a routing and a simulation-wide (static) methods for colecting edge weights.
The edge weights container "myEdgeSpeeds" is pre-initialised as soon as one device is built and is kept updated via an event that adapts it to the current mean speed on the simulated network's edges.
A device is assigned to a vehicle using the common explicit/probability - procedure.
A device computes a new route for a vehicle as soon as the vehicle is inserted (within "enterLaneAtInsertion") - and, if the given period is larger than 0 - each x time steps where x is the period. This is triggered by an event that executes "wrappedRerouteCommandExecute".
Definition at line 63 of file MSRoutingEngine.h.
Definition at line 65 of file MSRoutingEngine.h.
|
private |
Definition at line 212 of file MSRoutingEngine.h.
|
private |
Invalidated copy constructor.
|
staticprivate |
initialized edge speed storage into the given containers
Definition at line 114 of file MSRoutingEngine.cpp.
References OptionsCont::getBool(), MSNet::getCurrentTimeStep(), MSNet::getEdgeControl(), MSEdgeControl::getEdges(), OptionsCont::getFloat(), MSNet::getInstance(), OptionsCont::getInt(), OptionsCont::getOptions(), MSNet::getTravelTime(), MSGlobals::gWeightsSeparateTurns, OptionsCont::isDefault(), MAX2(), MIN2(), myAdaptationSteps, myAdaptationWeight, myEdgePriorityRange, myEdgeSpeeds, myEdgeTravelTimes, myLastAdaptation, myMinEdgePriority, myPriorityFactor, SIMTIME, TL, and WRITE_WARNING.
Referenced by initEdgeWeights().
Adapt edge efforts by the current edge states.
This method is called by the event handler at the end of a simulation step. The current edge weights are combined with the previously stored.
[in] | currentTime | The current simulation time |
Definition at line 217 of file MSRoutingEngine.cpp.
References OutputDevice::closeTag(), DEBUG_COND, DELTA_T, OutputDevice::getDeviceByOption(), MSNet::getEdgeControl(), MSEdgeControl::getEdges(), getEffortBike(), MSNet::getInstance(), OptionsCont::getOptions(), MSGlobals::gWeightsSeparateTurns, initEdgeWeights(), OptionsCont::isSet(), myAdaptationInterval, myAdaptationSteps, myAdaptationStepsIndex, myAdaptationWeight, myBikeSpeeds, myCachedRoutes, myEdgeBikeSpeeds, myEdgeSpeeds, myEffortFunc, myLastAdaptation, myPastEdgeBikeSpeeds, myPastEdgeSpeeds, OutputDevice::openTag(), patchSpeedForTurns(), SIMTIME, STEPS2TIME, SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_ATTR_ID, SUMO_TAG_EDGE, SUMO_TAG_INTERVAL, SVC_BICYCLE, SVC_PASSENGER, and OutputDevice::writeAttr().
Referenced by initWeightUpdate().
record actual travel time for an edge
Definition at line 484 of file MSRoutingEngine.cpp.
References MSEdge::getNumericalID(), and myEdgeTravelTimes.
Referenced by MSDevice_Routing::notifyEnter().
|
static |
deletes the router instance
Definition at line 516 of file MSRoutingEngine.cpp.
References MSGlobals::gNumThreads, myAdaptationInterval, myAdaptationStepsIndex, myCachedRoutes, myEdgeBikeSpeeds, myEdgeSpeeds, myEdgeTravelTimes, myPastEdgeBikeSpeeds, myPastEdgeSpeeds, and myRouterProvider.
Referenced by MSDevice::cleanupAll().
|
static |
return current travel speed assumption
Definition at line 211 of file MSRoutingEngine.cpp.
References MSEdge::getLength(), and myEffortFunc.
Referenced by MSEdge::getRoutingSpeed(), and MSEdge::getTravelTimeAggregated().
|
static |
return the cached route or nullptr on miss
Definition at line 363 of file MSRoutingEngine.cpp.
References myCachedRoutes.
Referenced by MSDevice_Routing::preInsertionReroute().
|
static |
Returns the effort to pass an edge.
This method is given to the used router in order to obtain the efforts to pass an edge from the internal edge weights container.
The time is not used, here, as the current simulation state is used in an aggregated way.
[in] | e | The edge for which the effort to be passed shall be returned |
[in] | v | The vehicle that is rerouted |
[in] | t | The time for which the effort shall be returned |
Definition at line 161 of file MSRoutingEngine.cpp.
References MSEdge::getLength(), MSEdge::getMinimumTravelTime(), MSEdge::getNumericalID(), MAX2(), and myEdgeSpeeds.
Referenced by getEffortExtra(), MSDevice_Routing::getParameter(), and initRouter().
|
static |
Definition at line 171 of file MSRoutingEngine.cpp.
References MSEdge::getLength(), MSEdge::getMinimumTravelTime(), MSEdge::getNumericalID(), MAX2(), and myEdgeBikeSpeeds.
Referenced by adaptEdgeEfforts(), and getEffortExtra().
|
static |
Definition at line 193 of file MSRoutingEngine.cpp.
References getEffort(), getEffortBike(), MSEdge::getPriority(), getThreadRNG(), SUMOTrafficObject::getVClass(), gWeightsRandomFactor, myBikeSpeeds, myEdgePriorityRange, myMinEdgePriority, myPriorityFactor, RandHelper::rand(), and SVC_BICYCLE.
Referenced by MSNet::getTravelTime(), and initRouter().
|
inlinestatic |
Information when the last edge weight adaptation occurred.
Definition at line 79 of file MSRoutingEngine.h.
References myLastAdaptation.
Referenced by MSDevice_Routing::reroute(), and MSTransportableDevice_Routing::reroute().
|
static |
return the router instance
Definition at line 492 of file MSRoutingEngine.cpp.
References MSNet::getEdgeControl(), MSNet::getInstance(), RouterProvider< E, L, N, V >::getVehicleRouter(), MFXWorkerThread::Pool::getWorkers(), MSGlobals::gNumThreads, initEdgeWeights(), initRouter(), initWeightUpdate(), myRouterProvider, MFXWorkerThread::Pool::size(), and UNUSED_PARAMETER.
Referenced by MSDispatch_Greedy::computeDispatch(), MSDispatch_GreedyClosest::computeDispatch(), MSDevice_Taxi::dispatchShared(), LIBSUMO_NAMESPACE::Simulation::findRoute(), MSBaseVehicle::BaseInfluencer::getRouterTT(), MSDevice_Routing::notifyEnter(), MSTriggeredRerouter::notifyEnter(), MSDevice_StationFinder::notifyMove(), MSDevice_Taxi::prepareStop(), and GUIVehicle::rerouteDRTStop().
|
staticprivate |
returns RNG associated with the current thread
Definition at line 180 of file MSRoutingEngine.cpp.
References myThreadRNGs.
Referenced by getEffortExtra().
|
inlinestatic |
returns whether any edge weight updates will take place
Definition at line 74 of file MSRoutingEngine.h.
References myEdgeWeightSettingCommand.
Referenced by MSDevice_Routing::MSDevice_Routing(), and MSTransportableDevice_Routing::MSTransportableDevice_Routing().
|
static |
initialize the edge weights if not done before
Definition at line 104 of file MSRoutingEngine.cpp.
References _initEdgeWeights(), myBikeSpeeds, myEdgeBikeSpeeds, myEdgeSpeeds, myPastEdgeBikeSpeeds, myPastEdgeSpeeds, and SVC_BICYCLE.
Referenced by adaptEdgeEfforts(), getRouterTT(), MSDevice_Routing::reroute(), and MSTransportableDevice_Routing::reroute().
|
static |
Definition at line 373 of file MSRoutingEngine.cpp.
References RouterProvider< E, L, N, V >::clone(), MSEdge::getAllEdges(), OptionsCont::getBool(), SUMOTrafficObject::getChosenSpeedFactor(), MSNet::getEdgeControl(), getEffort(), getEffortExtra(), OptionsCont::getFloat(), MSNet::getInstance(), OptionsCont::getInt(), OptionsCont::getOptions(), OptionsCont::getString(), MSNet::getTravelTime(), SUMOTrafficObject::getVClass(), MFXWorkerThread::Pool::getWorkers(), gWeightsRandomFactor, MSNet::hasPermissions(), OptionsCont::isSet(), myAdaptationInterval, myBikeSpeeds, myEffortFunc, myPriorityFactor, myRouterProvider, SUMOVehicle::setChosenSpeedFactor(), MFXWorkerThread::Pool::size(), string2time(), SUMOTime_MAX, SVC_PASSENGER, and TLF.
Referenced by getRouterTT(), and reroute().
|
static |
intialize period edge weight update
Definition at line 80 of file MSRoutingEngine.cpp.
References adaptEdgeEfforts(), MSEventControl::addEvent(), OutputDevice::createDeviceByOption(), OptionsCont::getBool(), MSNet::getEndOfTimestepEvents(), OptionsCont::getFloat(), MSNet::getInstance(), OptionsCont::getOptions(), OptionsCont::getString(), myAdaptationInterval, myAdaptationSteps, myAdaptationWeight, myEdgeSpeeds, myEdgeTravelTimes, myEdgeWeightSettingCommand, myLastAdaptation, myWithTaz, string2time(), TL, and WRITE_WARNING.
Referenced by MSTransportableDevice_Routing::buildDevices(), MSDevice_Routing::buildVehicleDevices(), and getRouterTT().
|
inlinestatic |
returns whether any routing actions take place
Definition at line 99 of file MSRoutingEngine.h.
References myAdaptationInterval, and myWithTaz.
Referenced by MSInsertionControl::determineCandidates(), and MSInsertionControl::emitVehicles().
|
private |
Invalidated assignment operator.
|
staticprivate |
Definition at line 295 of file MSRoutingEngine.cpp.
References DEBUG_COND, Named::getID(), MSEdge::getLength(), MSEdge::getViaSuccessors(), MSGlobals::gWeightsSeparateTurns, MAX2(), myAdaptationSteps, myAdaptationStepsIndex, myEdgeSpeeds, myEdgeTravelTimes, myPastEdgeSpeeds, SIMTIME, and STEPS2TIME.
Referenced by adaptEdgeEfforts().
|
static |
initiate the rerouting, create router / thread pool on first use
Definition at line 444 of file MSRoutingEngine.cpp.
References MFXWorkerThread::Pool::add(), MSNet::getEdgeControl(), MSNet::getInstance(), SUMOTrafficObject::getVClass(), RouterProvider< E, L, N, V >::getVehicleRouter(), initRouter(), myRouterProvider, myWithTaz, SUMOVehicle::reroute(), and MFXWorkerThread::Pool::size().
Referenced by MSDevice_Routing::reroute(), and MSRailSignal::LinkInfo::reroute().
|
static |
adapt the known travel time for an edge
Definition at line 479 of file MSRoutingEngine.cpp.
References MSEdge::getLength(), MSEdge::getNumericalID(), and myEdgeSpeeds.
Referenced by MSDevice_Routing::setParameter().
|
inlinestatic |
whether taz-routing is enabled
Definition at line 131 of file MSRoutingEngine.h.
References myWithTaz.
Referenced by MSDevice_Routing::notifyEnter().
|
staticprivate |
At which time interval the edge weights get updated.
Definition at line 201 of file MSRoutingEngine.h.
Referenced by adaptEdgeEfforts(), cleanup(), initRouter(), initWeightUpdate(), and isEnabled().
|
staticprivate |
The number of steps for averaging edge speeds (ring-buffer)
Definition at line 207 of file MSRoutingEngine.h.
Referenced by _initEdgeWeights(), adaptEdgeEfforts(), initWeightUpdate(), and patchSpeedForTurns().
|
staticprivate |
The current index in the pastEdgeSpeed ring-buffer.
Definition at line 210 of file MSRoutingEngine.h.
Referenced by adaptEdgeEfforts(), cleanup(), and patchSpeedForTurns().
|
staticprivate |
Information which weight prior edge efforts have.
Definition at line 198 of file MSRoutingEngine.h.
Referenced by _initEdgeWeights(), adaptEdgeEfforts(), and initWeightUpdate().
|
staticprivate |
whether separate speeds for bicycles shall be tracked
Definition at line 229 of file MSRoutingEngine.h.
Referenced by adaptEdgeEfforts(), getEffortExtra(), initEdgeWeights(), and initRouter().
|
staticprivate |
The container of pre-calculated routes.
Definition at line 237 of file MSRoutingEngine.h.
Referenced by adaptEdgeEfforts(), cleanup(), and getCachedRoute().
|
staticprivate |
Definition at line 216 of file MSRoutingEngine.h.
Referenced by adaptEdgeEfforts(), cleanup(), getEffortBike(), and initEdgeWeights().
|
staticprivate |
the difference between maximum and minimum priority for all edges
Definition at line 245 of file MSRoutingEngine.h.
Referenced by _initEdgeWeights(), and getEffortExtra().
|
staticprivate |
The container of edge speeds.
Definition at line 215 of file MSRoutingEngine.h.
Referenced by _initEdgeWeights(), adaptEdgeEfforts(), cleanup(), getEffort(), initEdgeWeights(), initWeightUpdate(), patchSpeedForTurns(), and setEdgeTravelTime().
|
staticprivate |
Sum of travel times experienced by equipped vehicles for each edge.
Definition at line 219 of file MSRoutingEngine.h.
Referenced by _initEdgeWeights(), addEdgeTravelTime(), cleanup(), initWeightUpdate(), and patchSpeedForTurns().
|
staticprivate |
The weights adaptation/overwriting command.
Definition at line 195 of file MSRoutingEngine.h.
Referenced by hasEdgeUpdates(), and initWeightUpdate().
|
static |
Definition at line 125 of file MSRoutingEngine.h.
Referenced by adaptEdgeEfforts(), getAssumedSpeed(), and initRouter().
|
staticprivate |
Information when the last edge weight adaptation occurred.
Definition at line 204 of file MSRoutingEngine.h.
Referenced by _initEdgeWeights(), adaptEdgeEfforts(), getLastAdaptation(), and initWeightUpdate().
|
staticprivate |
Minimum priority for all edges.
Definition at line 243 of file MSRoutingEngine.h.
Referenced by _initEdgeWeights(), and getEffortExtra().
|
staticprivate |
Definition at line 223 of file MSRoutingEngine.h.
Referenced by adaptEdgeEfforts(), cleanup(), and initEdgeWeights().
|
staticprivate |
The container of past edge speeds (when using a simple moving average)
Definition at line 222 of file MSRoutingEngine.h.
Referenced by adaptEdgeEfforts(), cleanup(), initEdgeWeights(), and patchSpeedForTurns().
|
staticprivate |
Coefficient for factoring edge priority into routing weight.
Definition at line 240 of file MSRoutingEngine.h.
Referenced by _initEdgeWeights(), getEffortExtra(), and initRouter().
|
staticprivate |
The router to use.
Definition at line 232 of file MSRoutingEngine.h.
Referenced by cleanup(), getRouterTT(), initRouter(), and reroute().
|
staticprivate |
Definition at line 234 of file MSRoutingEngine.h.
Referenced by getThreadRNG().
|
staticprivate |
whether taz shall be used at initial rerouting
Definition at line 226 of file MSRoutingEngine.h.
Referenced by initWeightUpdate(), isEnabled(), reroute(), and withTaz().