summaryrefslogtreecommitdiff
path: root/lib/Travel/Status
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2014-10-31 12:55:29 +0100
committerDaniel Friesel <derf@finalrewind.org>2014-10-31 12:55:29 +0100
commite85076209ad1c1d01a135154b54403c8c00bcc88 (patch)
tree108ccd818e3d8786fbea4641fd42f713b49bfa98 /lib/Travel/Status
parent9dede9a8f5e564b6375f2fc44f7eac0c4f8e0aef (diff)
db-iris, Result.pm: Document additional_stops and canceled_stops
Diffstat (limited to 'lib/Travel/Status')
-rw-r--r--lib/Travel/Status/DE/IRIS/Result.pm12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/IRIS/Result.pm b/lib/Travel/Status/DE/IRIS/Result.pm
index 68c0456..a121792 100644
--- a/lib/Travel/Status/DE/IRIS/Result.pm
+++ b/lib/Travel/Status/DE/IRIS/Result.pm
@@ -593,11 +593,23 @@ the platform, time, route and more.
=over
+=item $result->additional_stops
+
+Returns served stops which are not part of the schedule. I.e., this is the
+set of actual stops (B<route_post>) minus the set of scheduled stops
+(B<sched_route_post>).
+
=item $result->arrival
DateTime(3pm) object for the arrival date and time. undef if the
train starts here. Contains realtime data if available.
+=item $result->canceled_stops
+
+Returns stops which are scheduled, but will not be served by this train.
+I.e., this is the set of scheduled stops (B<sched_route_post>) minus the set of
+actual stops (B<route_post>).
+
=item $result->classes
List of characters indicating the class(es) of this train, may be empty. This