org.opentripplanner.raptor.spi.RaptorRoute Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

The newest version!

package org.opentripplanner.raptor.spi;

import org.opentripplanner.raptor.api.model.RaptorTripPattern;
import org.opentripplanner.raptor.api.model.RaptorTripSchedule;

/**
 * The {@link RaptorRoute} serve as the aggregate root for the transit model needed by Raptor to
 * perform the routing. From this class you should be able to navigate to the time-table, the
 * trip-pattern and access all trips within the pattern in service defined by the time-table.
 * 
 *
 * @param  The TripSchedule type defined by the user of the raptor API.
 */
public interface RaptorRoute {
  /**
   * Return a time-table. a list of all trips in service.
   */
  RaptorTimeTable timetable();

  /**
   * Return the trip-pattern, the list of stops visited by this route.
   */
  RaptorTripPattern pattern();
}