summaryrefslogtreecommitdiff
path: root/lib/Travel/Status
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2014-01-24 12:11:04 +0100
committerDaniel Friesel <derf@finalrewind.org>2014-01-24 12:11:04 +0100
commit673ae925dc81da62424bc0bb99dffdb07088acfe (patch)
tree7af21ae8cef3e113791af2cd4a6aca0a7a6bfeca /lib/Travel/Status
parentbfd099f967429eafdacb15fa8823443b51042272 (diff)
Result.pm: Add {delay,qos}_messages documentation
Diffstat (limited to 'lib/Travel/Status')
-rw-r--r--lib/Travel/Status/DE/IRIS/Result.pm15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/IRIS/Result.pm b/lib/Travel/Status/DE/IRIS/Result.pm
index 042637a..2b382c0 100644
--- a/lib/Travel/Status/DE/IRIS/Result.pm
+++ b/lib/Travel/Status/DE/IRIS/Result.pm
@@ -509,6 +509,14 @@ Estimated delay in minutes (integer number). undef when no realtime data is
available, negative if a train ends at the specified station and arrives /
arrived early.
+=item $result->delay_messages
+
+Get all delay messages entered for this train. Returns a list
+of [datetime, string] listrefs. The datetime part is a DateTime(3pm) object
+corresponding to the point in time when the message was entered, the string
+is the message. If a delay reason was entered more than once, only its oldest
+record will be returned.
+
=item $result->departure
DateTime(3pm) object for the departure date and time. undef if the train ends
@@ -555,6 +563,13 @@ filtered from this list.
Alias for route_start.
+=item $result->qos_messages
+
+Get all current qos messages for this train. Returns a list
+of [datetime, string] listrefs. The datetime part is a DateTime(3pm) object
+corresponding to the point in time when the message was entered, the string
+is the message. Contains neither superseded messages nor duplicates.
+
=item $result->platform
Arrivel/departure platform as string, undef if unknown. Note that this is