Cleanup raptor on trip access

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/TripSchedule.java

@@ -22,6 +22,12 @@ public interface TripSchedule extends DefaultTripSchedule {
    */
   TripPattern getOriginalTripPattern();
 
+  /**
+   * Return the index used to look up this trip in the
+   * {@link org.opentripplanner.raptor.spi.RaptorTimeTable#getTripSchedule(int)}.
+   */
+  int tripScheduleIndex();
+
   /**
    * Return {@code true} if this trip is not based on a fixed schedule, but instead a frequency
    * based scheduled trip. The {@link #frequencyHeadwayInSeconds()} is only defined for such trips.

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/frequency/FrequencyBoardOrAlightEvent.java

@@ -64,7 +64,7 @@ public FrequencyBoardOrAlightEvent(
   /* RaptorTripScheduleBoardOrAlightEvent implementation */
 
   @Override
-  public int tripIndex() {
+  public int tripScheduleIndex() {
     return tripTimes.getDepartureTime(0) + offset;
   }
 

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/request/RaptorRoutingRequestTransitData.java

@@ -16,6 +16,7 @@
 import org.opentripplanner.raptor.spi.RaptorStopNameResolver;
 import org.opentripplanner.raptor.spi.RaptorTransfer;
 import org.opentripplanner.raptor.spi.RaptorTransitDataProvider;
+import org.opentripplanner.raptor.spi.RaptorTripScheduleReference;
 import org.opentripplanner.raptor.util.BitSetIterator;
 import org.opentripplanner.routing.algorithm.raptoradapter.transit.DefaultSlackProvider;
 import org.opentripplanner.routing.algorithm.raptoradapter.transit.RaptorTransitData;
@@ -260,4 +261,9 @@ public RaptorConstrainedBoardingSearch<TripSchedule> transferConstraintsReverseS
     }
     return new ConstrainedBoardingSearch(false, toStopTransfers, fromStopTransfers);
   }
+
+  @Override
+  public RaptorTripScheduleReference tripScheduleReference(TripSchedule trip) {
+    return new RaptorTripScheduleReference(trip.pattern().patternIndex(), trip.tripScheduleIndex());
+  }
 }

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/request/TripPatternForDates.java

@@ -183,10 +183,6 @@ public int priorityGroupId() {
     return priorityGroupId;
   }
 
-  public int transitReluctanceFactorIndex() {
-    return tripPattern.transitReluctanceFactorIndex();
-  }
-
   @Override
   public String debugInfo() {
     return tripPattern.debugInfo();
@@ -222,6 +218,10 @@ public int numberOfTripSchedules() {
     return numberOfTripSchedules;
   }
 
+  public int transitReluctanceFactorIndex() {
+    return tripPattern.transitReluctanceFactorIndex();
+  }
+
   public Route route() {
     return tripPattern.route();
   }

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/request/TripScheduleAlightSearch.java

@@ -53,7 +53,7 @@ public T trip() {
   }
 
   @Override
-  public int tripIndex() {
+  public int tripScheduleIndex() {
     return candidateTripIndex;
   }
 

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/request/TripScheduleBoardSearch.java

@@ -51,7 +51,7 @@ public T trip() {
   }
 
   @Override
-  public int tripIndex() {
+  public int tripScheduleIndex() {
     return candidateTripIndex;
   }
 

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/request/TripScheduleWithOffset.java

@@ -81,6 +81,11 @@ public TripPattern getOriginalTripPattern() {
     return pattern.getTripPattern().getPattern();
   }
 
+  @Override
+  public int tripScheduleIndex() {
+    return tripIndexForDates;
+  }
+
   @Override
   public LocalDate getServiceDate() {
     if (tripTimes == null) {

application/src/main/java/org/opentripplanner/transfer/constrained/raptoradaptor/ConstrainedTransferBoarding.java

@@ -35,7 +35,7 @@ public ConstrainedTransferBoarding(
   }
 
   @Override
-  public int tripIndex() {
+  public int tripScheduleIndex() {
     return tripIndex;
   }
 

application/src/test/java/org/opentripplanner/raptorlegacy/_data/RaptorTestConstants.java

@@ -87,4 +87,10 @@ public interface RaptorTestConstants {
   default String stopIndexToName(int index) {
     return Character.toString('A' + index - 1);
   }
+
+  static RuntimeException createDeprecatedUnsupportedFeatureException() {
+    return new UnsupportedOperationException(
+      "This class is deprecated, we are not adding more features."
+    );
+  }
 }

application/src/test/java/org/opentripplanner/raptorlegacy/_data/transit/TestTransitData.java

@@ -1,5 +1,7 @@
 package org.opentripplanner.raptorlegacy._data.transit;
 
+import static org.opentripplanner.raptorlegacy._data.RaptorTestConstants.createDeprecatedUnsupportedFeatureException;
+
 import java.util.ArrayList;
 import java.util.BitSet;
 import java.util.HashSet;
@@ -19,6 +21,7 @@
 import org.opentripplanner.raptor.spi.RaptorTransfer;
 import org.opentripplanner.raptor.spi.RaptorTransitDataProvider;
 import org.opentripplanner.raptor.spi.RaptorTripPattern;
+import org.opentripplanner.raptor.spi.RaptorTripScheduleReference;
 import org.opentripplanner.raptor.util.BitSetIterator;
 import org.opentripplanner.raptorlegacy._data.RaptorTestConstants;
 import org.opentripplanner.routing.algorithm.raptoradapter.transit.cost.CostCalculatorFactory;
@@ -183,6 +186,11 @@ public RaptorConstrainedBoardingSearch<TestTripSchedule> transferConstraintsReve
     return getRoute(routeIndex).transferConstraintsReverseSearch();
   }
 
+  @Override
+  public RaptorTripScheduleReference tripScheduleReference(TestTripSchedule trip) {
+    throw createDeprecatedUnsupportedFeatureException();
+  }
+
   public TestRoute getRoute(int index) {
     return routes.get(index);
   }

application/src/test/java/org/opentripplanner/raptorlegacy/_data/transit/TestTripSchedule.java

@@ -1,6 +1,7 @@
 package org.opentripplanner.raptorlegacy._data.transit;
 
 import static org.opentripplanner.core.model.accessibility.Accessibility.NO_INFORMATION;
+import static org.opentripplanner.raptorlegacy._data.RaptorTestConstants.createDeprecatedUnsupportedFeatureException;
 
 import java.time.LocalDate;
 import java.util.Arrays;
@@ -125,6 +126,11 @@ public TripPattern getOriginalTripPattern() {
     return this.originalPattern;
   }
 
+  @Override
+  public int tripScheduleIndex() {
+    throw createDeprecatedUnsupportedFeatureException();
+  }
+
   @SuppressWarnings("UnusedReturnValue")
   public static class Builder {
 

application/src/test/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/request/TripAssert.java

@@ -52,7 +52,7 @@ TripAssert assertTripFound() {
   }
 
   TripAssert withIndex(int expectedTripIndex) {
-    assertEquals(expectedTripIndex, result.tripIndex(), "Trip index");
+    assertEquals(expectedTripIndex, result.tripScheduleIndex(), "Trip index");
     return this;
   }
 

application/src/test/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/request/TripScheduleAlightSearchTest.java

@@ -116,7 +116,7 @@ public void noTripsToAlightInEmptyPattern() {
   }
 
   @Test
-  public void findTripWithGivenTripIndexLowerBound() {
+  public void findTripWithGivenTripScheduleIndexLowerBound() {
     // Given a pattern with the following trips: A, B
     withTrips(tripA, tripB);
 

application/src/test/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/request/TripScheduleBoardSearchTest.java

@@ -111,7 +111,7 @@ public void noTripsToBoardInEmptyPattern() {
   }
 
   @Test
-  public void findTripWithGivenTripIndexUpperBound() {
+  public void findTripWithGivenTripScheduleIndexUpperBound() {
     // Given a pattern with the following trips: A, B
     int TRIP_INDEX_A = 0;
     int TRIP_INDEX_B = 1;

application/src/test/java/org/opentripplanner/transfer/constrained/raptoradaptor/ConstrainedBoardingSearchTest.java

@@ -446,7 +446,7 @@ private void assertBoarding(
       assertEquals(expectedConstraint, boarding.transferConstraint());
       assertEquals(stopIndex, boarding.boardStopIndex());
       assertEquals(targetStopPos, boarding.stopPositionInPattern());
-      assertEquals(expectedTripIndex, boarding.tripIndex());
+      assertEquals(expectedTripIndex, boarding.tripScheduleIndex());
     } else {
       assertTrue(boarding.empty());
     }

application/src/test/resources/speedtest/speed-test-config.json

@@ -2,6 +2,6 @@
   // Run all test-cases on the given date
   "testDate": "2009-12-17",
   "feedId": "1",
-  "graph": "not-used-but-requiered.obj",
+  "graph": "not-used-but-required.obj",
   "ignoreStreetResults": true
 }

raptor/src/main/java/org/opentripplanner/raptor/api/model/RaptorOnBoardAccess.java → raptor/src/main/java/org/opentripplanner/raptor/api/model/RaptorStartOnBoardAccess.java

@@ -1,28 +1,16 @@
 package org.opentripplanner.raptor.api.model;
 
 /**
- * RaptorOnBoardAccess allows you to board a specific trip at a given stop. The trip is
- * identified by the route index and trip schedule index. A typical use-case for this is when you
- * want to start a trip on-board, meaning that one is already on the vehicle when the path starts.
- * The returned paths will start with a zero duration access and a boarding at the given stop.
+ * This class allows you to board a specific trip at a given stop. The trip is identified by the
+ * route index and trip schedule index. A typical use-case for this is when you want to start a
+ * trip on-board, meaning that one is already on the vehicle when the path starts. The returned
+ * paths will start with a zero duration access and a boarding at the given stop.
  */
-public interface RaptorOnBoardAccess extends RaptorAccessEgress {
+public interface RaptorStartOnBoardAccess extends RaptorAccessEgress {
   /**
-   * The index of the boarded route
+   * Return the trip boarding this access is required to use.
    */
-  int routeIndex();
-
-  /**
-   * The index of the boarded trip within the route
-   */
-  int tripScheduleIndex();
-
-  /**
-   * The stop position in the route pattern for the board stop. It must refer to the same stop as
-   * the {@link #stop()} method. The stop position is required because the stop can be visited twice
-   * in case of a circular stop pattern.
-   */
-  int stopPositionInPattern();
+  RaptorTripScheduleStopPosition tripBoarding();
 
   /**
    * The stop index corresponding to {@link #stopPositionInPattern()}.

raptor/src/main/java/org/opentripplanner/raptor/api/model/RaptorTripScheduleStopPosition.java

@@ -0,0 +1,71 @@
+package org.opentripplanner.raptor.api.model;
+
+import java.util.Objects;
+import org.opentripplanner.utils.tostring.ToStringBuilder;
+
+/**
+ * This class contains information to identify a given stop in a stop pattern for a given trip
+ * schedule in a route. This can for example be used to identify where a bording or alighting
+ * happens.
+ */
+public final class RaptorTripScheduleStopPosition {
+
+  private final int routeIndex;
+  private final int tripScheduleIndex;
+  private final int stopPositionInPattern;
+
+  public RaptorTripScheduleStopPosition(
+    int routeIndex,
+    int tripScheduleIndex,
+    int stopPositionInPattern
+  ) {
+    this.routeIndex = routeIndex;
+    this.tripScheduleIndex = tripScheduleIndex;
+    this.stopPositionInPattern = stopPositionInPattern;
+  }
+
+  /// The index of the boarded route
+  public int routeIndex() {
+    return routeIndex;
+  }
+
+  /// The index of the boarded trip within the route
+  public int tripScheduleIndex() {
+    return tripScheduleIndex;
+  }
+
+  /// The stop position in the route stop-pattern. Knowing the stop index is not enough to identify
+  /// a stop, a stop may occour multiple times in a stop pattern, in other words a circular stop
+  /// pattern visits some of the same stops multiple times.
+  public int stopPositionInPattern() {
+    return stopPositionInPattern;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    RaptorTripScheduleStopPosition that = (RaptorTripScheduleStopPosition) o;
+    return (
+      routeIndex == that.routeIndex &&
+      tripScheduleIndex == that.tripScheduleIndex &&
+      stopPositionInPattern == that.stopPositionInPattern
+    );
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(routeIndex, tripScheduleIndex, stopPositionInPattern);
+  }
+
+  @Override
+  public String toString() {
+    // The field labels are shortened to improve reading - should be easy to get in the context
+    return ToStringBuilder.of(RaptorTripScheduleStopPosition.class)
+      .addNum("route", routeIndex)
+      .addNum("tripSchedule", tripScheduleIndex)
+      .addNum("stopPosition", stopPositionInPattern)
+      .toString();
+  }
+}

raptor/src/main/java/org/opentripplanner/raptor/api/view/ArrivalView.java

@@ -5,6 +5,7 @@
 
 import java.util.function.IntFunction;
 import javax.annotation.Nullable;
+import org.opentripplanner.raptor.api.model.RaptorTripScheduleStopPosition;
 import org.opentripplanner.raptor.spi.RaptorConstants;
 import org.opentripplanner.raptor.spi.RaptorCostCalculator;
 import org.opentripplanner.raptor.spi.RaptorTransfer;
@@ -146,7 +147,7 @@ default EgressPathView egressPath() {
 
   boolean arrivedOnBoard();
 
-  default TripScheduleStopPosition subsequentBoardingConstraint() {
+  default RaptorTripScheduleStopPosition subsequentBoardingConstraint() {
     throw new UnsupportedOperationException();
   }
 

raptor/src/main/java/org/opentripplanner/raptor/extensions/direct/service/DirectTransitSearch.java

@@ -140,7 +140,7 @@ private Optional<PathAndTripIndex<T>> findFirstPathInSearchWindow(
     }
 
     if (path.startTime() < latestDepartureTime) {
-      return Optional.of(new PathAndTripIndex<T>(path, boardEvent.tripIndex()));
+      return Optional.of(new PathAndTripIndex<T>(path, boardEvent.tripScheduleIndex()));
     }
     return Optional.empty();
   }