summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2015-04-19 11:14:42 +0200
committerDaniel Friesel <derf@finalrewind.org>2015-04-19 11:14:42 +0200
commit89e6115bbe2ac3965184fc9f347b0cf2f8c4ba8c (patch)
tree6cc0222070f087d9a8237a695609a0fffb1d0b0e /lib
parent2b8a73f11ea55cd167ba73c7883a581ab748d57c (diff)
Result: document wing accessors
Diffstat (limited to 'lib')
-rw-r--r--lib/Travel/Status/DE/IRIS/Result.pm18
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/IRIS/Result.pm b/lib/Travel/Status/DE/IRIS/Result.pm
index ce793ff..80319b5 100644
--- a/lib/Travel/Status/DE/IRIS/Result.pm
+++ b/lib/Travel/Status/DE/IRIS/Result.pm
@@ -734,6 +734,12 @@ 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_wings
+
+Returns a list of references to Travel::Status::DE::IRIS::Result(3pm) objects
+which are coupled to this train on arrival. Returns nothing (false / empty list)
+otherwise.
+
=item $result->canceled_stops
Returns stops which are scheduled, but will not be served by this train.
@@ -781,6 +787,12 @@ 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_wings
+
+Returns a list of references to Travel::Status::DE::IRIS::Result(3pm) objects
+which are coupled to this train on departure. Returns nothing (false / empty
+list) otherwise.
+
=item $result->destination
Alias for route_end.
@@ -809,6 +821,12 @@ the results and indicates it by setting B<is_transfer> to a true value.
In case of a transfer, B<train_id> and B<train_no> are set to the "new"
value, the old ones are available in B<old_train_id> and B<old_train_no>.
+=item $result->is_wing
+
+Returns true if this result is a wing, false otherwise.
+A wing is a train which has its own ID and destination, but is currently
+coupled to another train and shares all or some of its route.
+
=item $result->line
Train type with line (such as C<< S 1 >>) if available, type with number