summaryrefslogtreecommitdiff
path: root/lib/Travel/Status/DE/IRIS
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2017-05-29 19:14:26 +0200
committerDaniel Friesel <derf@finalrewind.org>2017-05-29 19:14:26 +0200
commit79dc274aaf8147d91c8401f75880681c7d39c6e0 (patch)
tree5267471523934f66d483bc2c12dfa699e81fd4b4 /lib/Travel/Status/DE/IRIS
parent5946c7941bd105fea6c038f41156c73720e04328 (diff)
Result: Document new addition/cancellation accessors
Diffstat (limited to 'lib/Travel/Status/DE/IRIS')
-rw-r--r--lib/Travel/Status/DE/IRIS/Result.pm24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/IRIS/Result.pm b/lib/Travel/Status/DE/IRIS/Result.pm
index 845b293..8731379 100644
--- a/lib/Travel/Status/DE/IRIS/Result.pm
+++ b/lib/Travel/Status/DE/IRIS/Result.pm
@@ -819,6 +819,15 @@ set of actual stops (B<route_post>) minus the set of scheduled stops
DateTime(3pm) object for the arrival date and time. undef if the
train starts here. Contains realtime data if available.
+=item $result->arrival_is_additional
+
+True if the arrival at this stop is an additional (unscheduled) event, i.e.,
+if the train started its journey earlier than planned.
+
+=item $result->arrival_is_cancelled
+
+True if the arrival at this stop has been cancelled.
+
=item $result->arrival_wings
Returns a list of references to Travel::Status::DE::IRIS::Result(3pm) objects
@@ -872,6 +881,16 @@ most recent record will be returned.
DateTime(3pm) object for the departure date and time. undef if the train ends
here. Contains realtime data if available.
+=item $result->departure_is_additional
+
+True if the train's departure at this stop is unscheduled (additional), i.e.,
+the route has been extended past its scheduled terminal stop.
+
+=item $result->departure_is_cancelled
+
+True if the train's departure at this stop has been cancelled, i.e., the train
+terminates here and does not continue its scheduled journey.
+
=item $result->departure_wings
Returns a list of references to Travel::Status::DE::IRIS::Result(3pm) objects
@@ -888,6 +907,11 @@ List of information strings. Contains both reasons for delays (which may or
may not be up-to-date) and generic information such as missing carriages or
broken toilets.
+=item $result->is_additional
+
+True if the train's arrival and departure at the stop are unscheduled
+additional stops, false otherwise.
+
=item $result->is_cancelled
True if the train was cancelled, false otherwise. Note that this does not