Merge pull request opentripplanner#7299 from opentripplanner/siri-arrived-departed

Support for Siri ArrivalStatus.ARRIVED on EstimatedCalls

Author: habrahamsson-skanetrafiken

application/src/main/java/org/opentripplanner/model/TripTimeOnDate.java

@@ -251,14 +251,14 @@ public int getRealtimeDeparture() {
    * Returns the actual arrival time if available. Otherwise -1 is returned.
    */
   public int getActualArrival() {
-    return isRecordedStop() ? tripTimes.getArrivalTime(stopPosition) : UNDEFINED;
+    return hasArrived() ? tripTimes.getArrivalTime(stopPosition) : UNDEFINED;
   }
 
   /**
    * Returns the actual departure time if available. Otherwise -1 is returned.
    */
   public int getActualDeparture() {
-    return isRecordedStop() ? tripTimes.getDepartureTime(stopPosition) : UNDEFINED;
+    return hasDeparted() ? tripTimes.getDepartureTime(stopPosition) : UNDEFINED;
   }
 
   public int getArrivalDelay() {
@@ -305,12 +305,14 @@ public boolean isNoDataStop() {
     return tripTimes.isNoDataStop(stopPosition);
   }
 
-  /**
-   * Is the real-time time a recorded time (i.e. has the vehicle already passed the stop).
-   * This information is currently only available from SIRI feeds.
-   */
-  public boolean isRecordedStop() {
-    return tripTimes.isRecordedStop(stopPosition);
+  /// True if there is realtime information indicating that the trip has arrived at the stop.
+  public boolean hasArrived() {
+    return tripTimes.hasArrived(stopPosition);
+  }
+
+  /// True if there is realtime information indicating that the trip has departed from the stop.
+  public boolean hasDeparted() {
+    return tripTimes.hasDeparted(stopPosition);
   }
 
   public RealTimeState getRealTimeState() {

application/src/main/java/org/opentripplanner/transit/model/timetable/RealTimeTripTimes.java

@@ -5,6 +5,7 @@
 
 import java.time.Duration;
 import java.util.Arrays;
+import java.util.BitSet;
 import java.util.List;
 import java.util.Objects;
 import java.util.OptionalInt;
@@ -30,7 +31,9 @@ public final class RealTimeTripTimes implements TripTimes<RealTimeTripTimes> {
   private final int[] departureTimes;
   private final RealTimeState realTimeState;
   private final StopRealTimeState[] stopRealTimeStates;
-  private final boolean[] extraCalls;
+  private final BitSet extraCalls;
+  private final BitSet hasArrived;
+  private final BitSet hasDeparted;
 
   @Nullable
   private final I18NString tripHeadsign;
@@ -50,6 +53,8 @@ public final class RealTimeTripTimes implements TripTimes<RealTimeTripTimes> {
     stopHeadsigns = builder.stopHeadsigns();
     occupancyStatus = builder.occupancyStatus();
     wheelchairAccessibility = builder.wheelchairAccessibility();
+    hasArrived = builder.hasArrived();
+    hasDeparted = builder.hasDeparted();
     validateNonIncreasingTimes();
   }
 
@@ -67,6 +72,8 @@ private RealTimeTripTimes(RealTimeTripTimes original, ScheduledTripTimes schedul
     this.stopHeadsigns = original.stopHeadsigns;
     this.occupancyStatus = original.occupancyStatus;
     this.wheelchairAccessibility = original.wheelchairAccessibility;
+    this.hasArrived = original.hasArrived;
+    this.hasDeparted = original.hasDeparted;
   }
 
   /**
@@ -86,6 +93,8 @@ private RealTimeTripTimes(RealTimeTripTimes original, int timeShift) {
     this.stopHeadsigns = original.stopHeadsigns;
     this.occupancyStatus = original.occupancyStatus;
     this.wheelchairAccessibility = original.wheelchairAccessibility;
+    this.hasArrived = original.hasArrived;
+    this.hasDeparted = original.hasDeparted;
   }
 
   ScheduledTripTimes scheduledTripTimes() {
@@ -180,8 +189,14 @@ public boolean isCancelledStop(int stopPos) {
     return isStopRealTimeStates(stopPos, StopRealTimeState.CANCELLED);
   }
 
-  public boolean isRecordedStop(int stopPos) {
-    return isStopRealTimeStates(stopPos, StopRealTimeState.RECORDED);
+  @Override
+  public boolean hasArrived(int stopPos) {
+    return hasArrived.get(stopPos);
+  }
+
+  @Override
+  public boolean hasDeparted(int stopPos) {
+    return hasDeparted.get(stopPos);
   }
 
   public boolean isNoDataStop(int stopPos) {
@@ -193,7 +208,7 @@ public boolean isPredictionInaccurate(int stopPos) {
   }
 
   public boolean isExtraCall(int stopPos) {
-    return extraCalls[stopPos];
+    return extraCalls.get(stopPos);
   }
 
   public boolean isRealTimeUpdated(int stopPos) {

application/src/main/java/org/opentripplanner/transit/model/timetable/RealTimeTripTimesBuilder.java

@@ -4,6 +4,7 @@
 import static org.opentripplanner.transit.model.timetable.TimetableValidationError.ErrorCode.MISSING_DEPARTURE_TIME;
 
 import java.util.Arrays;
+import java.util.BitSet;
 import java.util.stream.IntStream;
 import javax.annotation.Nullable;
 import org.opentripplanner.core.model.accessibility.Accessibility;
@@ -21,7 +22,9 @@ public class RealTimeTripTimesBuilder {
 
   private final StopRealTimeState[] stopRealTimeStates;
 
-  private final boolean[] extraCalls;
+  private final BitSet extraCalls;
+  private final BitSet hasArrived;
+  private final BitSet hasDeparted;
 
   @Nullable
   private I18NString tripHeadsign;
@@ -49,10 +52,12 @@ public class RealTimeTripTimesBuilder {
     departureTimes = new Integer[numStops];
     stopRealTimeStates = new StopRealTimeState[numStops];
     Arrays.fill(stopRealTimeStates, StopRealTimeState.DEFAULT);
-    extraCalls = new boolean[numStops];
+    extraCalls = new BitSet(numStops);
     stopHeadsigns = new I18NString[numStops];
     occupancyStatus = new OccupancyStatus[numStops];
     Arrays.fill(occupancyStatus, OccupancyStatus.NO_DATA_AVAILABLE);
+    hasArrived = new BitSet(numStops);
+    hasDeparted = new BitSet(numStops);
   }
 
   /**
@@ -202,12 +207,16 @@ public StopRealTimeState[] stopRealTimeStates() {
     return stopRealTimeStates.clone();
   }
 
-  public boolean[] extraCalls() {
-    return extraCalls.clone();
+  public BitSet extraCalls() {
+    return (BitSet) extraCalls.clone();
   }
 
-  public RealTimeTripTimesBuilder withRecorded(int stop) {
-    return withStopRealTimeState(stop, StopRealTimeState.RECORDED);
+  public BitSet hasArrived() {
+    return (BitSet) hasArrived.clone();
+  }
+
+  public BitSet hasDeparted() {
+    return (BitSet) hasDeparted.clone();
   }
 
   public RealTimeTripTimesBuilder withCanceled(int stop) {
@@ -228,7 +237,23 @@ public RealTimeTripTimesBuilder withStopRealTimeState(int stop, StopRealTimeStat
   }
 
   public RealTimeTripTimesBuilder withExtraCall(int stop, boolean extraCall) {
-    this.extraCalls[stop] = extraCall;
+    this.extraCalls.set(stop, extraCall);
+    return this;
+  }
+
+  public RealTimeTripTimesBuilder withHasArrived(int stop, boolean arrived) {
+    if (stop > numberOfStops()) {
+      throw new IllegalArgumentException("Stop index out of range");
+    }
+    this.hasArrived.set(stop, arrived);
+    return this;
+  }
+
+  public RealTimeTripTimesBuilder withHasDeparted(int stop, boolean departed) {
+    if (stop > numberOfStops()) {
+      throw new IllegalArgumentException("Stop index out of range");
+    }
+    this.hasDeparted.set(stop, departed);
     return this;
   }
 

application/src/main/java/org/opentripplanner/transit/model/timetable/ScheduledTripTimes.java

@@ -231,7 +231,12 @@ public boolean isCancelledStop(int stopPos) {
   }
 
   @Override
-  public boolean isRecordedStop(int stopPos) {
+  public boolean hasArrived(int stopPosition) {
+    return false;
+  }
+
+  @Override
+  public boolean hasDeparted(int stopPosition) {
     return false;
   }
 

application/src/main/java/org/opentripplanner/transit/model/timetable/TripTimes.java

@@ -133,7 +133,11 @@ default int compareTo(TripTimes other) {
 
   boolean isCancelledStop(int stopPos);
 
-  boolean isRecordedStop(int stopPos);
+  /// True if there is realtime information indicating that the trip has arrived at the stop.
+  boolean hasArrived(int stopPosition);
+
+  /// True if there is realtime information indicating that the trip has departed from the stop.
+  boolean hasDeparted(int stopPosition);
 
   boolean isNoDataStop(int stopPos);
 

application/src/main/java/org/opentripplanner/transit/model/timetable/TripTimesStringBuilder.java

@@ -15,7 +15,8 @@ public class TripTimesStringBuilder {
    *
    * Where flags are:
    * C: Canceled
-   * R: Recorded
+   * R: Recorded (Arrived & Departed)
+   * A: Arrived but not departed
    * PI: Prediction Inaccurate
    * ND: No Data
    * </pre>
@@ -39,8 +40,12 @@ public static String encodeTripTimes(TripTimes tripTimes, TripPattern pattern) {
       if (tripTimes.isCancelledStop(i)) {
         flags.add("C");
       }
-      if (tripTimes.isRecordedStop(i)) {
-        flags.add("R");
+      if (tripTimes.hasArrived(i)) {
+        if (tripTimes.hasDeparted(i)) {
+          flags.add("R");
+        } else {
+          flags.add("A");
+        }
       }
       if (tripTimes.isPredictionInaccurate(i)) {
         flags.add("PI");

application/src/main/java/org/opentripplanner/updater/trip/siri/CallWrapper.java

@@ -60,6 +60,9 @@ static List<CallWrapper> of(EstimatedVehicleJourney estimatedVehicleJourney) {
   CallStatusEnumeration getDepartureStatus();
   DepartureBoardingActivityEnumeration getDepartureBoardingActivity();
 
+  /// Whether the call is a RecordedCall or not
+  boolean isRecorded();
+
   final class EstimatedCallWrapper implements CallWrapper {
 
     private final EstimatedCall call;
@@ -148,6 +151,11 @@ public DepartureBoardingActivityEnumeration getDepartureBoardingActivity() {
       return call.getDepartureBoardingActivity();
     }
 
+    @Override
+    public boolean isRecorded() {
+      return false;
+    }
+
     @Override
     public int hashCode() {
       return call.hashCode();
@@ -250,6 +258,11 @@ public DepartureBoardingActivityEnumeration getDepartureBoardingActivity() {
       return null;
     }
 
+    @Override
+    public boolean isRecorded() {
+      return true;
+    }
+
     @Override
     public int hashCode() {
       return call.hashCode();

application/src/main/java/org/opentripplanner/updater/trip/siri/TimetableHelper.java

@@ -8,6 +8,7 @@
 import org.opentripplanner.transit.model.timetable.RealTimeTripTimesBuilder;
 import org.opentripplanner.updater.trip.siri.mapping.OccupancyMapper;
 import org.opentripplanner.utils.time.ServiceDateUtils;
+import uk.org.siri.siri21.CallStatusEnumeration;
 import uk.org.siri.siri21.NaturalLanguageStringStructure;
 import uk.org.siri.siri21.OccupancyEnumeration;
 
@@ -59,9 +60,11 @@ public static void applyUpdates(
     CallWrapper call,
     OccupancyEnumeration journeyOccupancy
   ) {
-    if (call.getActualDepartureTime() != null || call.getActualArrivalTime() != null) {
-      //Flag as recorded
-      tripTimesBuilder.withRecorded(index);
+    if (call.isRecorded() || call.getArrivalStatus() == CallStatusEnumeration.ARRIVED) {
+      tripTimesBuilder.withHasArrived(index, true);
+    }
+    if (call.isRecorded()) {
+      tripTimesBuilder.withHasDeparted(index, true);
     }
 
     // Set flag for inaccurate prediction if either call OR journey has inaccurate-flag set.

application/src/test/java/org/opentripplanner/model/TripTimeOnDateTest.java

@@ -50,23 +50,39 @@ void gtfsSequence() {
   }
 
   @Test
-  void isRecordedStop() {
+  void hasArrivedStop() {
     var pattern = TEST_MODEL.pattern(TransitMode.BUS).build();
     var trip = TimetableRepositoryForTest.trip("123").build();
     var stopTimes = TEST_MODEL.stopTimesEvery5Minutes(3, trip, "11:00");
 
     var tripTimes = TripTimesFactory.tripTimes(trip, stopTimes, new Deduplicator())
       .createRealTimeFromScheduledTimes()
-      .withRecorded(1)
+      .withHasArrived(1, true)
       .build();
 
     var subject = new TripTimeOnDate(tripTimes, 0, pattern);
-
-    assertFalse(subject.isRecordedStop());
+    assertFalse(subject.hasArrived());
 
     subject = new TripTimeOnDate(tripTimes, 1, pattern);
+    assertTrue(subject.hasArrived());
+  }
+
+  @Test
+  void hasDepartedStop() {
+    var pattern = TEST_MODEL.pattern(TransitMode.BUS).build();
+    var trip = TimetableRepositoryForTest.trip("123").build();
+    var stopTimes = TEST_MODEL.stopTimesEvery5Minutes(3, trip, "11:00");
 
-    assertTrue(subject.isRecordedStop());
+    var tripTimes = TripTimesFactory.tripTimes(trip, stopTimes, new Deduplicator())
+      .createRealTimeFromScheduledTimes()
+      .withHasDeparted(1, true)
+      .build();
+
+    var subject = new TripTimeOnDate(tripTimes, 0, pattern);
+    assertFalse(subject.hasDeparted());
+
+    subject = new TripTimeOnDate(tripTimes, 1, pattern);
+    assertTrue(subject.hasDeparted());
   }
 
   @Test

application/src/test/java/org/opentripplanner/updater/trip/siri/AddedTripBuilderTest.java

@@ -194,10 +194,8 @@ void testAddedTrip() {
     assertEquals(secondsInDay(10, 20), scheduledTimes.getDepartureTime(0));
     assertEquals(0, scheduledTimes.getDepartureDelay(0));
     assertEquals(HEADSIGN, scheduledTimes.getHeadsign(0).toString());
-    assertFalse(
-      scheduledTimes.isRecordedStop(0),
-      "Scheduled timetable should not have actual departure time"
-    );
+    assertFalse(scheduledTimes.hasArrived(0), "Scheduled timetable should not have arrived");
+    assertFalse(scheduledTimes.hasDeparted(0), "Scheduled timetable should not have departed");
     assertEquals(secondsInDay(10, 30), scheduledTimes.getArrivalTime(1));
     assertEquals(secondsInDay(10, 30), scheduledTimes.getDepartureTime(1));
     assertEquals(0, scheduledTimes.getArrivalDelay(1));
@@ -215,16 +213,19 @@ void testAddedTrip() {
     assertEquals(secondsInDay(10, 19), times.getDepartureTime(0));
     assertEquals(-60, times.getDepartureDelay(0));
     assertEquals(HEADSIGN, times.getHeadsign(0).toString());
-    assertTrue(times.isRecordedStop(0), "First stop has actual departure time");
+    assertTrue(times.hasArrived(0), "First stop should have arrived");
+    assertTrue(times.hasDeparted(0), "First stop should have departed");
     assertEquals(secondsInDay(10, 29), times.getArrivalTime(1));
     assertEquals(secondsInDay(10, 31), times.getDepartureTime(1));
     assertEquals(-60, times.getArrivalDelay(1));
     assertEquals(60, times.getDepartureDelay(1));
-    assertFalse(times.isRecordedStop(1), "First stop has actual departure time");
+    assertFalse(times.hasArrived(1), "Second stop should not have arrived");
+    assertFalse(times.hasDeparted(1), "Second stop should not have departed");
     assertEquals(secondsInDay(10, 41), times.getArrivalTime(2));
     assertEquals(secondsInDay(10, 41), times.getDepartureTime(2));
     assertEquals(60, times.getArrivalDelay(2));
-    assertFalse(times.isRecordedStop(2), "First stop has actual departure time");
+    assertFalse(times.hasArrived(1), "Third stop should not have arrived");
+    assertFalse(times.hasDeparted(1), "Third stop should not have departed");
   }
 
   @Test
@@ -599,6 +600,7 @@ private static List<CallWrapper> getCalls(int hour) {
         .withAimedDepartureTime(zonedDateTime(hour, 20))
         .withExpectedDepartureTime(zonedDateTime(hour, 20))
         .withActualDepartureTime(zonedDateTime(hour, 19))
+        .withIsRecorded(true)
         .build(),
       TestCall.of()
         .withStopPointRef(STOP_B.getId().getId())