diff options
| author | Daniel Friesel <derf@finalrewind.org> | 2022-10-28 08:30:44 +0200 |
|---|---|---|
| committer | Daniel Friesel <derf@finalrewind.org> | 2022-10-28 08:30:44 +0200 |
| commit | eef938bb3688a8a64c2853ceb237d28e3bfd861b (patch) | |
| tree | 6eb6560c2db423fbdcd7637693a7c4e413e99341 /lib/Travel/Status | |
| parent | a9d5268457783df67c77b3bce67d9f750ba14df1 (diff) | |
document load accessor
Diffstat (limited to 'lib/Travel/Status')
| -rw-r--r-- | lib/Travel/Status/DE/HAFAS/Journey.pm | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/HAFAS/Journey.pm b/lib/Travel/Status/DE/HAFAS/Journey.pm index 5f1290b..b236e5d 100644 --- a/lib/Travel/Status/DE/HAFAS/Journey.pm +++ b/lib/Travel/Status/DE/HAFAS/Journey.pm @@ -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. |