Unverified Commit eef938bb authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

document load accessor

parent a9d52684
Loading
Loading
Loading
Loading
+10 −0
Original line number Diff line number Diff line
@@ -428,6 +428,14 @@ otherwise. May be undef.

True if the real-time platform is known and it is not the scheduled one.

=item $journey->load (station only)

Expected passenger load (i.e., how full the vehicle is) at the requested stop.
If known, returns a hashref that maps classes (typically FIRST/SECOND) to
load estimation numbers. The DB backend uses 1 (low to medium), 2 (high),
3 (very high), and 4 (exceptionally high, train is booked out).
Undef if unknown.

=item $journey->messages

Returns a list of message strings related to this journey. Messages usually are
@@ -476,6 +484,8 @@ entire route. Each hash contains the following keys:

=item * direction (direction signage from this stop on, undef if unchanged)

=item * load (expected utilization / passenger load from this stop on)

=back

Individual entries may be undef.