Merge pull request #359 from HSLdevcom/feat/assigned-stop-id

Add assigned-stop-id

pom.xml

@@ -2,7 +2,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>fi.hsl</groupId>
     <artifactId>transitdata-common</artifactId>
-    <version>1.5.6-RC</version>
+    <version>1.6.0-RC</version>
     <packaging>jar</packaging>
     <name>Common utilities for Transitdata projects</name>
     <properties>

protos/gtfs-realtime.proto

@@ -182,6 +182,35 @@ message TripUpdate {
     extensions 1000 to 1999;
   }
 
+  // Realtime update for certain properties defined within GTFS stop_times.txt.
+  // Caution: this message is still experimental, and subject to change. It
+  // may be formally adopted in the future.
+  message StopTimeProperties {
+    // Supports real-time stop assignments. Refers to a stop_id defined in the
+    // GTFS stops.txt.
+    //
+    // The new assigned_stop_id should not result in a significantly different
+    // trip experience for the end user than the stop_id defined in GTFS
+    // stop_times.txt. In other words, the end user should not view this new
+    // stop_id as an "unusual change" if the new stop was presented within an
+    // app without any additional context. For example, this field is intended
+    // to be used for platform assignments by using a stop_id that belongs to
+    // the same station as the stop originally defined in GTFS stop_times.txt.
+    //
+    // To assign a stop without providing any real-time arrival or departure
+    // predictions, populate this field and set
+    // StopTimeUpdate.schedule_relationship = NO_DATA.
+    //
+    // If this field is populated, StopTimeUpdate.stop_sequence must be
+    // populated and StopTimeUpdate.stop_id should not be populated. Stop
+    // assignments should be reflected in other GTFS-realtime fields as well
+    // (e.g., VehiclePosition.stop_id).
+    //
+    // Caution: this field is still experimental, and subject to change. It
+    // may be formally adopted in the future.
+    optional string assigned_stop_id = 1;
+  }
+
   // Realtime update for arrival and/or departure events for a given stop on a
   // trip. Updates can be supplied for both past and future events.
   // The producer is allowed, although not required, to drop past events.
@@ -221,6 +250,8 @@ message TripUpdate {
     optional ScheduleRelationship schedule_relationship = 5
         [default = SCHEDULED];
 
+    optional StopTimeProperties stop_time_properties = 6;
+
     // The extensions namespace allows 3rd-party developers to extend the
     // GTFS Realtime Specification in order to add and evaluate new features
     // and modifications to the spec.