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

import org.opentripplanner.transit.raptor.api.path.Path;
import org.opentripplanner.transit.raptor.api.transit.IntIterator;
import org.opentripplanner.transit.raptor.api.transit.RaptorTransfer;
import org.opentripplanner.transit.raptor.api.transit.RaptorTripSchedule;

import java.util.Collection;
import java.util.Iterator;

/**
 * TODO TGR
 * @param  The TripSchedule type defined by the user of the raptor API.
 */
public interface WorkerState {

    void setInitialTimeForIteration(RaptorTransfer accessEgressLeg, int iterationDepartureTime);

    boolean isNewRoundAvailable();

    IntIterator stopsTouchedPreviousRound();

    IntIterator stopsTouchedByTransitCurrentRound();

    void transferToStops(int fromStop, Iterator transfers);

    /**
     * Extract paths after the search is complete. This method is optional,
     * returning an empty set by default.
     *
     * @return return all paths found in the search.
     */
    Collection> extractPaths();

    /**
     * Return TRUE if at least one new destination arrival is accepted at the destination in
     * the current round. If no paths to the destination is found in the current round, FALSE
     * is returned. And last, if a new path is found in the current round - reaching the
     * destination - but the path is NOT accepted(not pareto-optimal), then FALSE is returned.
     * 
     * This method is called at the end of each round.
     */
    boolean isDestinationReachedInCurrentRound();
}