org.opentripplanner.transit.raptor.rangeraptor.transit.TripScheduleExactMatchSearch 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.transit.raptor.rangeraptor.transit;

import org.opentripplanner.transit.raptor.api.transit.RaptorTripSchedule;


/**
 * This trip search will only match trips that is within the given slack of the timeLimit.
 * 
 * Let say we want to board a trip and the 'earliest boarding time' is 12:10:00, and the slack is 60 seconds.
 * Then all trip leaving from 12:10:00 to 12:11:00 is accepted. This is used to prevent boarding trips that
 * depart long after the Range Raptor search window. The Range Raptor algorithm implemented here uses this
 * wrapper for round 1, for all other rounds the normal {@link TripScheduleBoardSearch} or
 * {@link TripScheduleAlightSearch} is used.
 * 
 * This class do not perform the trip search, but delegates this.
 *
 * @param  The TripSchedule type defined by the user of the raptor API.
 */
public class TripScheduleExactMatchSearch implements TripScheduleSearch {

    private final int slack;
    private final TripScheduleSearch delegate;
    private final TransitCalculator calculator;

    TripScheduleExactMatchSearch(TripScheduleSearch delegate, TransitCalculator calculator, int slack) {
        this.delegate = delegate;
        this.slack = slack;
        this.calculator = calculator;
    }

    @Override
    public boolean search(int timeLimit, int stopPositionInPattern) {
        boolean result = delegate.search(timeLimit, stopPositionInPattern);
        return result && isWithinSlack(timeLimit);
    }

    @Override
    public boolean search(int timeLimit, int stopPositionInPattern, int tripIndexLimit) {
        boolean result = delegate.search(timeLimit, stopPositionInPattern, tripIndexLimit);
        return result && isWithinSlack(timeLimit);
    }

    @Override
    public T getCandidateTrip() {
        return delegate.getCandidateTrip();
    }

    @Override
    public int getCandidateTripIndex() {
        return delegate.getCandidateTripIndex();
    }

    @Override
    public int getCandidateTripTime() {
        return delegate.getCandidateTripTime();
    }

    private boolean isWithinSlack(int timeLimit) {
        return calculator.isBest(delegate.getCandidateTripTime(), timeLimit + slack);
    }
}