Commit 79dc274a authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

Result: Document new addition/cancellation accessors

parent 5946c794
Loading
Loading
Loading
Loading
+24 −0
Original line number Original line Diff line number Diff line
@@ -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
DateTime(3pm) object for the arrival date and time. undef if the
train starts here. Contains realtime data if available.
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
=item $result->arrival_wings


Returns a list of references to Travel::Status::DE::IRIS::Result(3pm) objects
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
DateTime(3pm) object for the departure date and time. undef if the train ends
here. Contains realtime data if available.
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
=item $result->departure_wings


Returns a list of references to Travel::Status::DE::IRIS::Result(3pm) objects
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
may not be up-to-date) and generic information such as missing carriages or
broken toilets.
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
=item $result->is_cancelled


True if the train was cancelled, false otherwise. Note that this does not
True if the train was cancelled, false otherwise. Note that this does not