Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GTFS Trip-Modifications #403

Merged
merged 42 commits into from
Mar 11, 2024
Merged
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
b2bfcf5
Add Trip-Modification, make shape non-experimental
gcamp Sep 25, 2023
ab5e996
Create a page for TripModifications entities for consistency with TU …
npaun Oct 10, 2023
7887381
Clarify providing TUs for modified trips and ReplacementStop time int…
npaun Oct 10, 2023
da1c109
Merge remote-tracking branch 'google/master' into gtfsrt/trip_modific…
gcamp Oct 11, 2023
52d4064
Fix first_stop_reference.png not having the right image + optimize im…
gcamp Oct 12, 2023
c2f88a0
Fix optional/require for Stop message
gcamp Oct 19, 2023
9a0d6d5
Clarify behaviour and linkage to TripUpdates
gcamp Oct 23, 2023
7a67845
Apply Modification clarification proposed changes
gcamp Oct 23, 2023
364e32b
Use ModifiedTripSelector instead of concatenation of IDs
gcamp Dec 5, 2023
f3944b0
Add details on behavior when is provided
gcamp Dec 6, 2023
8533985
Remove modifications_id
gcamp Dec 11, 2023
121049c
Merge pull request #12 from TransitApp/feature/trip_modification_sele…
gcamp Dec 11, 2023
4b90e8a
Fix after comments from @bdferris-v2
gcamp Dec 20, 2023
7ef14f5
Add note about producer needed the two versions of trip updates
gcamp Dec 21, 2023
8f5d394
Fix bad relationship mentionned, + force no other entity when using M…
gcamp Jan 8, 2024
0126942
Changes after Jan 10 call
gcamp Jan 11, 2024
429c56b
Merge remote-tracking branch 'google/master' into gtfsrt/trip_modific…
gcamp Jan 17, 2024
e0b0f48
Add experimental notices
gcamp Feb 20, 2024
14e4259
Remove mention of stop pattern
gcamp Feb 20, 2024
36f3cac
Use stop selector instead of stop sequence only
gcamp Feb 20, 2024
b92a5b2
Update to end_stop_selector
gcamp Feb 21, 2024
fb9c8df
Update proto with start/end stop selector
gcamp Feb 21, 2024
b5f65bf
Add selected trips
gcamp Feb 21, 2024
f26ded5
Update reference with SelectedTrips
gcamp Feb 21, 2024
5e6f44c
Update trip modif doc
gcamp Feb 21, 2024
a91db62
Add last_modified_time
gcamp Feb 21, 2024
47a3ceb
Add missing start_times in pb
gcamp Feb 22, 2024
99aba67
Fix typos, fix description of selected trips
gcamp Feb 22, 2024
c4e94d9
Fix typos
gcamp Feb 22, 2024
437fc84
Update reference for clarity
gcamp Feb 22, 2024
ae77b32
Clarify and remove duplicated information
gcamp Feb 22, 2024
1c54a21
Consistancy
gcamp Feb 22, 2024
be4a9c6
Changes before experimental vote
gcamp Feb 22, 2024
51980b8
Revert correctly shape experimental
gcamp Feb 28, 2024
5afb5de
Merge branch 'final/trip_modification' into gtfsrt/trip_modifications
gcamp Feb 28, 2024
2721fe0
Editorial, formatting clarifications
jfabi Mar 1, 2024
a1e4af7
Merge pull request #17 from jfabi/gtfsrt/trip_modifications_editorial
gcamp Mar 5, 2024
19b4d2e
Apply suggestions from @sam-hickey-ibigroup
gcamp Mar 5, 2024
37f290d
Update documentation images with new fields, add source files
gcamp Mar 5, 2024
418702a
Clarifies behavior of propagated_modification_delay when no stop_time…
gcamp Mar 5, 2024
b437508
Remove extra word
gcamp Mar 5, 2024
4be2666
Sync .proto and reference files
gcamp Mar 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update reference for clarity
  • Loading branch information
gcamp committed Feb 22, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 437fc8426b99072124e62e79130663e9ed2a7cb3
6 changes: 3 additions & 3 deletions gtfs-realtime/spec/en/reference.md
Original file line number Diff line number Diff line change
@@ -626,7 +626,7 @@ A `TripModifications` message identifies a list of similar trips which are all a

## _message_ Modification

A `Modification` message replaces a span of n stop times (`num_stops_replaced`) from each affected trip starting at `start_stop_sequence`.
A `Modification` message replaces a span of n stop times from each affected trip starting at `start_stop_selector`.
gcamp marked this conversation as resolved.
Show resolved Hide resolved

<br><br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.

@@ -641,7 +641,7 @@ _Propagated detour delays affect all stops following the end of a modification.

| _**Field Name**_ | _**Type**_ | _**Required**_ | _**Cardinality**_ | _**Description**_ |
|------------------|------------|----------------|-------------------|-------------------|
| **start_stop_selector** | [StopSelector](#message-stopselector) | Required | One | The stop selector of the first stop of the original trip that is to be affected by this modification. If `end_stop_selector` is not provided, no stop will be removed and the stop from the `start_stop_selector` is only provided as a reference stop for `travel_time_to_stop` calculations. |
| **start_stop_selector** | [StopSelector](#message-stopselector) | Required | One | The stop selector of the first stop of the original trip that is to be affected by this modification. If `end_stop_selector` is not provided, no stop will be removed and the stop from the `start_stop_selector` is only provided as a reference stop for `travel_time_to_stop` calculations. See `travel_time_to_stop` for more details. |
| **end_stop_selector** | [StopSelector](#message-stopselector) | Conditionally required | One | The stop selector of the last stop of the original trip that is to be affected by this modification. The selection is inclusive, so if only one stop_time is replaced by that modification, `start_stop_selector` and `end_stop_selector` should be equivalent. If no stop_time is replaced, `end_stop_selector` should not be provided. It's otherwise required. |
| **propagated_modification_delay** | [int32](https://protobuf.dev/programming-guides/proto2/#scalar) | Optional | One | The number of seconds of delay to add to all departure and arrival times following the end of this modification. Can be a positive or negative number. If multiple modifications apply to the same trip, the delays accumulate as the trip advances. <br/><br/>If the value is not supplied, consumers MAY interpolate or infer the `propagated_modification_delay` based on other data. |
| **replacement_stops** | [ReplacementStop](#message-replacementstop) | Optional | Many | A list of replacement stops, replacing those of the original trip. The length of the new stop times may be less, the same, or greater than the number of replaced stop times. |
@@ -689,4 +689,4 @@ _If a modification affects the first stop of the trip, that stop also serves as
| _**Field Name**_ | _**Type**_ | _**Required**_ | _**Cardinality**_ | _**Description**_ |
|------------------|------------|----------------|-------------------|-------------------|
| **stop_id** | [string](https://protobuf.dev/programming-guides/proto2/#scalar) | Required | One | The replacement stop ID which will now be visited by the trip. May refer to a new stop added using a GTFS-RT `Stop` message, or to an existing stop defined in the (CSV) GTFS feed’s `stops.txt`. The stop MUST have `location_type=0` (routable stops). |
| **travel_time_to_stop** | [int32](https://protobuf.dev/programming-guides/proto2/#scalar) | Optional | One | The difference in seconds between the arrival time at this stop and the arrival time at the reference stop. The reference stop is the stop prior to `start_stop_sequence`. If the modification begins at the first stop of the trip, then the first stop of the trip is the reference stop. <br/><br/>This value MUST be monotonically increasing and may only be a negative number if the first stop of the original trip is the reference stop. <br/><br/>If the value is not supplied, consumers MAY interpolate or infer the `travel_time_to_stop` based on other data. |
| **travel_time_to_stop** | [int32](https://protobuf.dev/programming-guides/proto2/#scalar) | Optional | One | The difference in seconds between the arrival time at this stop and the arrival time at the reference stop. The reference stop is the stop prior to `start_stop_selector`. If the modification begins at the first stop of the trip, then the first stop of the trip is the reference stop. <br/><br/>This value MUST be monotonically increasing and may only be a negative number if the first stop of the original trip is the reference stop. <br/><br/>If the value is not supplied, consumers MAY interpolate or infer the `travel_time_to_stop` based on other data. |