Public Member Functions | |
| List<? extends PlanElement > | calcRoute (RoutingRequest request) |
Detailed Description
Defines classes responsible for routing for a given (main)-mode. It does not modify the plan.
Definition at line 35 of file RoutingModule.java.
Member Function Documentation
◆ calcRoute()
| List<? extends PlanElement> org.matsim.core.router.RoutingModule.calcRoute | ( | RoutingRequest | request | ) |
Computes a route, as a sequence of plan elements. The plan elements can be only legs, or a sequence of legs and "dummy" activities. All activity types inserted as dummy activities must have a type which ends on "interaction".
important: if route computation relies on a shortest path algorithm using TravelTime and/or TravelDisutility estimators, this method is responsible for setting the person to the argument person in those estimators before running the shortest path algorithm.
The method parameters prior to MATSim 14 have been collected in a RoutingRequest object. To retrofit older code, use DefaultRoutingRequest.of(...) to wrap your method arguments.
- Parameters
-
request a RoutingRequest represents origin, destination, departure time, etc.
- Returns
- a list of PlanElement, in proper order, representing the trip.
Implemented in org.matsim.core.router.NetworkRoutingInclAccessEgressModule, org.matsim.core.router.TransitRouterWrapper, org.matsim.core.router.NetworkRoutingModule, ch.sbb.matsim.routing.pt.raptor.SwissRailRaptorRoutingModule, org.matsim.core.router.TeleportationRoutingModule, and org.matsim.core.router.FreespeedFactorRoutingModule.
Referenced by ch.sbb.matsim.routing.pt.raptor.DefaultRaptorStopFinder.addInitialStopsForParamSet(), ch.sbb.matsim.routing.pt.raptor.SwissRailRaptorRoutingModule.calcRoute(), org.matsim.core.router.TripRouter.calcRoute(), and org.matsim.core.router.TransitRouterWrapper.createWalkRoute().
The documentation for this interface was generated from the following file:
- core/router/RoutingModule.java
