org.matsim.pt.router.TransitRouterImpl Class Reference

Inheritance diagram for org.matsim.pt.router.TransitRouterImpl:

Public Member Functions
	TransitRouterImpl (final TransitRouterConfig trConfig, final TransitSchedule schedule)
	TransitRouterImpl (final TransitRouterConfig trConfig, final PreparedTransitSchedule preparedTransitSchedule, final TransitRouterNetwork routerNetwork, final TravelTime travelTime, final TransitTravelDisutility travelDisutility)
List<? extends PlanElement >	calcRoute (final RoutingRequest request)
TransitRouterNetwork	getTransitRouterNetwork ()

Protected Member Functions
void	setTransitTravelDisutility (TransitTravelDisutility transitTravelDisutility)
final double	getWalkTime (Person person, Coord coord, Coord toCoord)
final double	getTransferTime (Person person, Coord coord, Coord toCoord)
final List< Leg >	createDirectWalkLegList (Person person, Coord fromCoord, Coord toCoord)
List< Leg >	convertPassengerRouteToLegList (double departureTime, InternalTransitPassengerRoute p, Coord fromCoord, Coord toCoord, Person person)
final TransitRouterConfig	getConfig ()
final double	getWalkDisutility (Person person, Coord coord, Coord toCoord)
final TransitTravelDisutility	getTravelDisutility ()

Private Member Functions
Map< Node, InitialNode >	locateWrappedNearestTransitNodes (Person person, Coord coord, double departureTime)

Private Attributes
final TransitRouterNetwork	transitNetwork
final TravelTime	travelTime
final TransitTravelDisutility	travelDisutility
final PreparedTransitSchedule	preparedTransitSchedule
boolean	cacheTree
TransitLeastCostPathTree	tree
Facility	previousFromFacility
double	previousDepartureTime

Detailed Description

Not thread-safe because MultiNodeDijkstra is not. Does not expect the TransitSchedule to change once constructed! michaz '13

Author

mrieser

Definition at line 45 of file TransitRouterImpl.java.

Constructor & Destructor Documentation

TransitRouterImpl() [1/2]

org.matsim.pt.router.TransitRouterImpl.TransitRouterImpl	(	final TransitRouterConfig	trConfig,
		final TransitSchedule	schedule
	)

Definition at line 57 of file TransitRouterImpl.java.

References org.matsim.pt.router.TransitRouterNetwork.createFromSchedule(), org.matsim.pt.router.TransitRouterConfig.getBeelineWalkConnectionDistance(), org.matsim.pt.router.TransitRouterConfig.isCacheTree(), and org.matsim.pt.router.AbstractTransitRouter.setTransitTravelDisutility().

                                                                                                 {
        super(trConfig);
        this.transitNetwork = TransitRouterNetwork.createFromSchedule(schedule,
                trConfig.getBeelineWalkConnectionDistance());
        this.preparedTransitSchedule = new PreparedTransitSchedule(schedule);
        TransitRouterNetworkTravelTimeAndDisutility transitRouterNetworkTravelTimeAndDisutility = new TransitRouterNetworkTravelTimeAndDisutility(
                trConfig,
                new PreparedTransitSchedule(schedule));
        this.travelDisutility = transitRouterNetworkTravelTimeAndDisutility;
        this.travelTime = transitRouterNetworkTravelTimeAndDisutility;
        setTransitTravelDisutility(this.travelDisutility);
        
        this.cacheTree = trConfig.isCacheTree();
    }

Here is the call graph for this function:

TransitRouterImpl() [2/2]

org.matsim.pt.router.TransitRouterImpl.TransitRouterImpl	(	final TransitRouterConfig	trConfig,
		final PreparedTransitSchedule	preparedTransitSchedule,
		final TransitRouterNetwork	routerNetwork,
		final TravelTime	travelTime,
		final TransitTravelDisutility	travelDisutility
	)

Definition at line 72 of file TransitRouterImpl.java.

References org.matsim.pt.router.TransitRouterConfig.isCacheTree(), org.matsim.pt.router.TransitRouterImpl.preparedTransitSchedule, org.matsim.pt.router.TransitRouterImpl.travelDisutility, and org.matsim.pt.router.TransitRouterImpl.travelTime.

                                                            {

        super(trConfig, travelDisutility);

        this.transitNetwork = routerNetwork;
        this.preparedTransitSchedule = preparedTransitSchedule;
        this.travelDisutility = travelDisutility;
        this.travelTime = travelTime;
        
        this.cacheTree = trConfig.isCacheTree();
    }

Here is the call graph for this function:

Member Function Documentation

locateWrappedNearestTransitNodes()

Map<Node, InitialNode> org.matsim.pt.router.TransitRouterImpl.locateWrappedNearestTransitNodes ( Person  person, Coord  coord, double  departureTime  )

private

Definition at line 89 of file TransitRouterImpl.java.

References org.matsim.core.utils.geometry.CoordUtils.calcEuclideanDistance(), org.matsim.pt.router.AbstractTransitRouter.getConfig(), org.matsim.pt.router.TransitRouterNetwork.getNearestNode(), org.matsim.pt.router.TransitRouterNetwork.getNearestNodes(), org.matsim.pt.router.TransitRouterImpl.getTransitRouterNetwork(), org.matsim.pt.router.AbstractTransitRouter.getWalkDisutility(), and org.matsim.pt.router.AbstractTransitRouter.getWalkTime().

Referenced by org.matsim.pt.router.TransitRouterImpl.calcRoute().

                                                                                                                      {
        Collection<TransitRouterNetwork.TransitRouterNetworkNode> nearestNodes = getTransitRouterNetwork().getNearestNodes(
                coord,
                this.getConfig().getSearchRadius());
        if (nearestNodes.size() < 2) {
            // also enlarge search area if only one stop found, maybe a second one is near the border of the search area
            TransitRouterNetwork.TransitRouterNetworkNode nearestNode = this.getTransitRouterNetwork()
                                                                            .getNearestNode(coord);
            if (nearestNode != null) { // transit schedule might be completely empty!
                double distance = CoordUtils.calcEuclideanDistance(coord,
                        nearestNode.stop.getStopFacility().getCoord());
                nearestNodes = this.getTransitRouterNetwork()
                                   .getNearestNodes(coord, distance + this.getConfig().getExtensionRadius());
            }
        }
        Map<Node, InitialNode> wrappedNearestNodes = new LinkedHashMap<>();
        for (TransitRouterNetwork.TransitRouterNetworkNode node : nearestNodes) {
            Coord toCoord = node.stop.getStopFacility().getCoord();
            double initialTime = getWalkTime(person, coord, toCoord);
            double initialCost = getWalkDisutility(person, coord, toCoord);
            wrappedNearestNodes.put(node, new InitialNode(initialCost, initialTime + departureTime));
        }
        return wrappedNearestNodes;
    }

Here is the call graph for this function:

calcRoute()

List<? extends PlanElement> org.matsim.pt.router.TransitRouterImpl.calcRoute

(

final RoutingRequest

request

)

Implements org.matsim.pt.router.TransitRouter.

Definition at line 115 of file TransitRouterImpl.java.

References org.matsim.pt.router.AbstractTransitRouter.convertPassengerRouteToLegList(), org.matsim.pt.router.AbstractTransitRouter.getConfig(), org.matsim.api.core.v01.BasicLocation.getCoord(), org.matsim.core.router.RoutingRequest.getDepartureTime(), org.matsim.pt.router.TransitRouterConfig.getDirectWalkFactor(), org.matsim.core.router.RoutingRequest.getFromFacility(), org.matsim.core.router.RoutingRequest.getPerson(), org.matsim.core.router.RoutingRequest.getToFacility(), org.matsim.pt.router.TransitLeastCostPathTree.getTransitPassengerRoute(), org.matsim.pt.router.TransitRouterImpl.getTransitRouterNetwork(), org.matsim.pt.router.InternalTransitPassengerRoute.getTravelCost(), org.matsim.pt.router.AbstractTransitRouter.getTravelDisutility(), org.matsim.pt.router.AbstractTransitRouter.getWalkDisutility(), org.matsim.pt.router.TransitRouterImpl.locateWrappedNearestTransitNodes(), and org.matsim.pt.router.TransitRouterImpl.previousDepartureTime.

                                                                                 {
        final Facility fromFacility = request.getFromFacility();
        final Facility toFacility = request.getToFacility();
        final double departureTime = request.getDepartureTime();
        final Person person = request.getPerson();
        
        // find possible start stops
        Map<Node, InitialNode> wrappedFromNodes = this.locateWrappedNearestTransitNodes(person,
                fromFacility.getCoord(),
                departureTime);
        
        
        // find possible end stops
        Map<Node, InitialNode> wrappedToNodes = this.locateWrappedNearestTransitNodes(person,
                toFacility.getCoord(),
                departureTime);

        InternalTransitPassengerRoute transitPassengerRoute = null;

        if (cacheTree) {
            if ((fromFacility != previousFromFacility) && (departureTime != previousDepartureTime)) { // Compute tree only if fromFacility and departure time are different from previous request.
                tree = new TransitLeastCostPathTree(getTransitRouterNetwork(),
                        getTravelDisutility(),
                        getTravelTime(),
                        wrappedFromNodes,
                        person);
            }
        } else { // Compute new tree for every routing request
            tree = new TransitLeastCostPathTree(getTransitRouterNetwork(),
                    getTravelDisutility(),
                    getTravelTime(),
                    wrappedFromNodes,
                    wrappedToNodes,
                    person);
            // yyyyyy This sounds like it is doing the full tree.  But I think it is not. Kai, nov'16
            // Yes, only if you leave out the wrappedToNodes from the argument list, it does compute the full tree. See the new case above. dz, june'18
        }

        // find routes between start and end stop
        transitPassengerRoute = tree.getTransitPassengerRoute(wrappedToNodes);

        if (transitPassengerRoute == null) {
            return null; // TripRouter / FallbackRoutingModule will create a direct walk leg
        }
        double pathCost = transitPassengerRoute.getTravelCost();

        double directWalkCost = getWalkDisutility(person, fromFacility.getCoord(), toFacility.getCoord());

        if (directWalkCost * getConfig().getDirectWalkFactor() < pathCost) {
            return null; // TripRouter / FallbackRoutingModule will create a direct walk leg
        }
        
        previousFromFacility = fromFacility;
        previousDepartureTime = departureTime;
        
        return convertPassengerRouteToLegList(departureTime,
                transitPassengerRoute,
                fromFacility.getCoord(),
                toFacility.getCoord(),
                person);
    }

Here is the call graph for this function:

getTransitRouterNetwork()

TransitRouterNetwork org.matsim.pt.router.TransitRouterImpl.getTransitRouterNetwork

(

)

Definition at line 177 of file TransitRouterImpl.java.

References org.matsim.pt.router.TransitRouterImpl.preparedTransitSchedule, org.matsim.pt.router.TransitRouterImpl.transitNetwork, and org.matsim.pt.router.TransitRouterImpl.travelTime.

Referenced by org.matsim.pt.router.TransitRouterImpl.calcRoute(), and org.matsim.pt.router.TransitRouterImpl.locateWrappedNearestTransitNodes().

                                                          {
        return transitNetwork;
    }

setTransitTravelDisutility()

void org.matsim.pt.router.AbstractTransitRouter.setTransitTravelDisutility ( TransitTravelDisutility  transitTravelDisutility )

protectedinherited

Definition at line 55 of file AbstractTransitRouter.java.

Referenced by org.matsim.pt.router.TransitRouterImpl.TransitRouterImpl().

                                                                                              {
        this.travelDisutility = transitTravelDisutility;
    }

getWalkTime()

final double org.matsim.pt.router.AbstractTransitRouter.getWalkTime ( Person  person, Coord  coord, Coord  toCoord  )

protectedinherited

Definition at line 60 of file AbstractTransitRouter.java.

References org.matsim.pt.router.AbstractTransitRouter.getTravelDisutility(), and org.matsim.pt.router.TransitTravelDisutility.getWalkTravelTime().

Referenced by org.matsim.pt.router.AbstractTransitRouter.createDirectWalkLegList(), org.matsim.pt.router.AbstractTransitRouter.createTransitWalkLeg(), and org.matsim.pt.router.TransitRouterImpl.locateWrappedNearestTransitNodes().

                                                                                  {
        return getTravelDisutility().getWalkTravelTime(person, coord, toCoord);
    }

Here is the call graph for this function:

getTransferTime()

final double org.matsim.pt.router.AbstractTransitRouter.getTransferTime ( Person  person, Coord  coord, Coord  toCoord  )

protectedinherited

Definition at line 64 of file AbstractTransitRouter.java.

References org.matsim.pt.router.TransitRouterConfig.getAdditionalTransferTime(), org.matsim.pt.router.AbstractTransitRouter.getConfig(), org.matsim.pt.router.AbstractTransitRouter.getTravelDisutility(), and org.matsim.pt.router.TransitTravelDisutility.getWalkTravelTime().

Referenced by org.matsim.pt.router.AbstractTransitRouter.createTransferTransitWalkLeg().

                                                                                      {
        return getTravelDisutility().getWalkTravelTime(person, coord, toCoord) + this.getConfig().getAdditionalTransferTime();
    }

Here is the call graph for this function:

createDirectWalkLegList()

final List<Leg> org.matsim.pt.router.AbstractTransitRouter.createDirectWalkLegList ( Person  person, Coord  fromCoord, Coord  toCoord  )

protectedinherited

TODO: Replace by FallbackRoutingModule?! - gl-nov'19

Definition at line 72 of file AbstractTransitRouter.java.

References org.matsim.core.population.routes.RouteUtils.createGenericRouteImpl(), org.matsim.core.population.PopulationUtils.createLeg(), org.matsim.pt.router.AbstractTransitRouter.getWalkTime(), org.matsim.api.core.v01.TransportMode.pt, org.matsim.core.router.TripStructureUtils.setRoutingMode(), org.matsim.api.core.v01.population.Route.setTravelTime(), and org.matsim.api.core.v01.TransportMode.walk.

                                                                                                     {
        List<Leg> legs = new ArrayList<>();
        Leg leg = PopulationUtils.createLeg(TransportMode.walk);
        double walkTime = getWalkTime(person, fromCoord, toCoord);
        leg.setTravelTime(walkTime);
        TripStructureUtils.setRoutingMode(leg, TransportMode.pt);
        Route walkRoute = RouteUtils.createGenericRouteImpl(null, null);
        walkRoute.setTravelTime(walkTime);
        leg.setRoute(walkRoute);
        legs.add(leg);
        return legs;
    }

Here is the call graph for this function:

convertPassengerRouteToLegList()

List<Leg> org.matsim.pt.router.AbstractTransitRouter.convertPassengerRouteToLegList ( double  departureTime, InternalTransitPassengerRoute  p, Coord  fromCoord, Coord  toCoord, Person  person  )

protectedinherited

Definition at line 116 of file AbstractTransitRouter.java.

References org.matsim.pt.router.AbstractTransitRouter.createAccessTransitWalkLeg(), org.matsim.pt.router.AbstractTransitRouter.createEgressTransitWalkLeg(), org.matsim.pt.router.AbstractTransitRouter.createTransferTransitWalkLeg(), org.matsim.pt.router.AbstractTransitRouter.createTransitLeg(), and org.matsim.pt.router.InternalTransitPassengerRoute.getRoute().

Referenced by org.matsim.pt.router.TransitRouterImpl.calcRoute().

                                                                                                                                                             {
        // convert the route into a sequence of legs
        List<Leg> legs = new ArrayList<>();

        // access leg
        Leg accessLeg;
        // check if first leg extends walking distance
        if (p.getRoute().get(0).getRouteTaken() == null) {
            // route starts with transfer - extend initial walk to that stop
            //TODO: what if first leg extends the walking distance to more than first routeSegment i.e., (accessLeg, transfer, transfer ...). Amit Jan'18
//          accessLeg = createTransitWalkLeg(fromCoord, p.getRoute().get(0).getToStop().getCoord());
            accessLeg = createAccessTransitWalkLeg(fromCoord, p.getRoute().get(0));
            p.getRoute().remove(0);
        } else {
            // do not extend it - add a regular walk leg
            //
//          accessLeg = createTransitWalkLeg(fromCoord, p.getRoute().get(0).getFromStop().getCoord());
            accessLeg = createAccessTransitWalkLeg(fromCoord, p.getRoute().get(0));
        }

        // egress leg
        Leg egressLeg;
        // check if first leg extends walking distance
        if (p.getRoute().get(p.getRoute().size() - 1).getRouteTaken() == null) {
            // route starts with transfer - extend initial walk to that stop
//          egressLeg = createTransitWalkLeg(p.getRoute().get(p.getRoute().size() - 1).getFromStop().getCoord(), toCoord);
            egressLeg = createEgressTransitWalkLeg(p.getRoute().get(p.getRoute().size() - 1), toCoord);
            p.getRoute().remove(p.getRoute().size() - 1);
        } else {
            // do not extend it - add a regular walk leg
            // access leg
//          egressLeg = createTransitWalkLeg(p.getRoute().get(p.getRoute().size() - 1).getToStop().getCoord(), toCoord);
            egressLeg = createEgressTransitWalkLeg(p.getRoute().get(p.getRoute().size() - 1), toCoord);
        }


        // add very first leg
        legs.add(accessLeg);

        // route segments are now in pt-walk-pt sequence
        for (RouteSegment routeSegement : p.getRoute()) {
            if (routeSegement.getRouteTaken() == null) {// transfer
                if (!routeSegement.fromStop.equals(routeSegement.toStop)) { // same to/from stop => no transfer. Amit Feb'18
                    legs.add(createTransferTransitWalkLeg(routeSegement));
                }
            } else {
                // pt leg
                legs.add(createTransitLeg(routeSegement));
            }
        }

        // add last leg
        legs.add(egressLeg);

        return legs;
    }

Here is the call graph for this function:

getConfig()

final TransitRouterConfig org.matsim.pt.router.AbstractTransitRouter.getConfig ( )

protectedinherited

Definition at line 196 of file AbstractTransitRouter.java.

References org.matsim.pt.router.AbstractTransitRouter.trConfig.

Referenced by org.matsim.pt.router.TransitRouterImpl.calcRoute(), org.matsim.pt.router.AbstractTransitRouter.getTransferTime(), and org.matsim.pt.router.TransitRouterImpl.locateWrappedNearestTransitNodes().

                                                    {
        return trConfig;
    }

getWalkDisutility()

final double org.matsim.pt.router.AbstractTransitRouter.getWalkDisutility ( Person  person, Coord  coord, Coord  toCoord  )

protectedinherited

Definition at line 200 of file AbstractTransitRouter.java.

References org.matsim.pt.router.AbstractTransitRouter.getTravelDisutility(), and org.matsim.pt.router.TransitTravelDisutility.getWalkTravelDisutility().

Referenced by org.matsim.pt.router.TransitRouterImpl.calcRoute(), and org.matsim.pt.router.TransitRouterImpl.locateWrappedNearestTransitNodes().

                                                                                        {
        return getTravelDisutility().getWalkTravelDisutility(person, coord, toCoord);
    }

Here is the call graph for this function:

getTravelDisutility()

final TransitTravelDisutility org.matsim.pt.router.AbstractTransitRouter.getTravelDisutility ( )

protectedinherited

Definition at line 204 of file AbstractTransitRouter.java.

References org.matsim.pt.router.AbstractTransitRouter.travelDisutility.

Referenced by org.matsim.pt.router.TransitRouterImpl.calcRoute(), org.matsim.pt.router.AbstractTransitRouter.getTransferTime(), org.matsim.pt.router.AbstractTransitRouter.getWalkDisutility(), and org.matsim.pt.router.AbstractTransitRouter.getWalkTime().

                                                                  {
        return travelDisutility;
    }

Member Data Documentation

transitNetwork

final TransitRouterNetwork org.matsim.pt.router.TransitRouterImpl.transitNetwork

private

Definition at line 47 of file TransitRouterImpl.java.

Referenced by org.matsim.pt.router.TransitRouterImpl.getTransitRouterNetwork().

travelTime

final TravelTime org.matsim.pt.router.TransitRouterImpl.travelTime

private

Definition at line 48 of file TransitRouterImpl.java.

Referenced by org.matsim.pt.router.TransitRouterImpl.getTransitRouterNetwork(), and org.matsim.pt.router.TransitRouterImpl.TransitRouterImpl().

travelDisutility

final TransitTravelDisutility org.matsim.pt.router.TransitRouterImpl.travelDisutility

private

Definition at line 49 of file TransitRouterImpl.java.

Referenced by org.matsim.pt.router.TransitRouterImpl.TransitRouterImpl().

preparedTransitSchedule

final PreparedTransitSchedule org.matsim.pt.router.TransitRouterImpl.preparedTransitSchedule

private

Definition at line 50 of file TransitRouterImpl.java.

Referenced by org.matsim.pt.router.TransitRouterImpl.getTransitRouterNetwork(), and org.matsim.pt.router.TransitRouterImpl.TransitRouterImpl().

cacheTree

boolean org.matsim.pt.router.TransitRouterImpl.cacheTree

private

Definition at line 52 of file TransitRouterImpl.java.

tree

TransitLeastCostPathTree org.matsim.pt.router.TransitRouterImpl.tree

private

Definition at line 53 of file TransitRouterImpl.java.

previousFromFacility

Facility org.matsim.pt.router.TransitRouterImpl.previousFromFacility

private

Definition at line 54 of file TransitRouterImpl.java.

previousDepartureTime

double org.matsim.pt.router.TransitRouterImpl.previousDepartureTime

private

Definition at line 55 of file TransitRouterImpl.java.

Referenced by org.matsim.pt.router.TransitRouterImpl.calcRoute().

---

The documentation for this class was generated from the following file:

• pt/router/TransitRouterImpl.java