Package org.matsim.core.router

Interface RoutingModule

All Known Subinterfaces:

FallbackRoutingModule

All Known Implementing Classes:

FreespeedFactorRoutingModule, NetworkRoutingInclAccessEgressModule, NetworkRoutingModule, SwissRailRaptorRoutingModule, TeleportationRoutingModule, TransitRouterWrapper

public interface RoutingModule

Defines classes responsible for routing for a given (main)-mode. It does not modify the plan.

Author:

thibautd

Method Summary

Modifier and Type	Method	Description
List<? extends PlanElement>	calcRoute(Facility fromFacility, Facility toFacility, double departureTime, Person person)	Computes a route, as a sequence of plan elements.

Method Detail

calcRoute

List<? extends PlanElement> calcRoute(Facility fromFacility,
                                      Facility toFacility,
                                      double departureTime,
                                      Person person)

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.

Parameters:

fromFacility - a Facility representing the departure location

toFacility - a Facility representing the arrival location

departureTime - the departure time

person - the Person to route

Returns:

a list of PlanElement, in proper order, representing the trip.