org.opentripplanner.routing.algorithm.raptor.router.street.AccessEgressRouter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
There is a newer version: 2.5.0
package org.opentripplanner.routing.algorithm.raptor.router.street;

import org.opentripplanner.graph_builder.module.NearbyStopFinder;
import org.opentripplanner.routing.algorithm.raptor.transit.AccessEgress;
import org.opentripplanner.routing.algorithm.raptor.transit.StopIndexForRaptor;
import org.opentripplanner.routing.api.request.RoutingRequest;
import org.opentripplanner.routing.graph.Vertex;
import org.opentripplanner.routing.graphfinder.StopAtDistance;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Set;

/**
 * This uses a street search to find paths to all the access/egress stop within range
 */
public class AccessEgressRouter {
    private static Logger LOG = LoggerFactory.getLogger(AccessEgressRouter.class);

    private AccessEgressRouter() {}

    /**
     *
     * @param rr the current routing request
     * @param fromTarget whether to route from or towards the point provided in the routing request
     *                   (access or egress)
     * @param distanceMeters the maximum street distance to search for access/egress stops
     * @return Transfer objects by access/egress stop
     */
    public static Collection streetSearch (
        RoutingRequest rr,
        boolean fromTarget,
        int distanceMeters,
        StopIndexForRaptor stopIndex
    ) {
        // TODO OTP2 This has to be done because we have not separated the main RoutingRequest from
        //      the subrequest for street searches. From/to vertices are already set based on the main
        //      request being arriveBy or not, but here we are actually setting arriveBy based on
        //      whether we are doing an access or egress search, regardless of the direction of the
        //      main request.
        Set vertices = fromTarget ^ rr.arriveBy ? rr.rctx.toVertices : rr.rctx.fromVertices;

        RoutingRequest nonTransitRoutingRequest = rr.getStreetSearchRequest(
            fromTarget ? rr.modes.egressMode : rr.modes.accessMode
        );

        NearbyStopFinder nearbyStopFinder = new NearbyStopFinder(rr.rctx.graph, distanceMeters, true);
        // We set removeTempEdges to false because this is a sub-request - the temporary edges for the origin and
        // target vertex will be cleaned up at the end of the super-request, and we don't want that to happen twice.
        List stopAtDistanceList =
                nearbyStopFinder.findNearbyStopsViaStreets(
                    vertices,
                    fromTarget,
                    false,
                    nonTransitRoutingRequest
                );

        Collection result = new ArrayList<>();
        for (StopAtDistance stopAtDistance : stopAtDistanceList) {
            result.add(
                new AccessEgress(
                    stopIndex.indexByStop.get(stopAtDistance.stop),
                    (int)stopAtDistance.state.getElapsedTimeSeconds(),
                    fromTarget ? stopAtDistance.state.reverse() : stopAtDistance.state
                )
            );
        }

        LOG.debug("Found {} {} stops", result.size(), fromTarget ? "egress" : "access");

        return result;
    }
}