From e85076209ad1c1d01a135154b54403c8c00bcc88 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Fri, 31 Oct 2014 12:55:29 +0100
Subject: db-iris, Result.pm: Document additional_stops and canceled_stops

---
 bin/db-iris                         | 10 ++++++++++
 lib/Travel/Status/DE/IRIS/Result.pm | 12 ++++++++++++
 2 files changed, 22 insertions(+)

diff --git a/bin/db-iris b/bin/db-iris
index 7207b66..d3da1dc 100755
--- a/bin/db-iris
+++ b/bin/db-iris
@@ -436,6 +436,16 @@ Valid output types are:
 
 =over
 
+=item a / additional
+
+If a train's route deviates from its schedule: Print a list of additional
+(unscheduled) stops it will stop at.
+
+=item c / canceled
+
+If a train's route deviates from its schedule: Print a list of canceled
+stops (scheduled stops which will not be served).
+
 =item d / delay
 
 If a train is delayed, show the most recent reason for this delay.
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
-- 
cgit v1.2.3