summaryrefslogtreecommitdiff
path: root/lib/Travel/Status/DE/EFA/Result.pm
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2021-03-25 22:01:00 +0100
committerDaniel Friesel <derf@finalrewind.org>2021-03-25 22:01:00 +0100
commitcc9dd0a40d8a1f048426a5cad22c67f882ed8724 (patch)
tree0803f17bd2e1b0ff17340347616ddb6187edaa43 /lib/Travel/Status/DE/EFA/Result.pm
parentea5057170c475287d9946b069745aa9c51269952 (diff)
Result: document occupancy accessor
Diffstat (limited to 'lib/Travel/Status/DE/EFA/Result.pm')
-rw-r--r--lib/Travel/Status/DE/EFA/Result.pm8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/EFA/Result.pm b/lib/Travel/Status/DE/EFA/Result.pm
index 20241f7..4a4736a 100644
--- a/lib/Travel/Status/DE/EFA/Result.pm
+++ b/lib/Travel/Status/DE/EFA/Result.pm
@@ -208,6 +208,14 @@ and 11.
Returns the "mode of transport", for instance "zug", "s-bahn", "tram" or
"sonstige".
+=item $departure->occupancy
+
+Returns expected occupancy, if available, undef otherwise.
+
+Occupancy values are passed from the backend as-is. Known values are
+"MANY_SEATS" (low occupation), "FEW_SEATS" (high occupation), and
+"STANDING_ONLY" (very high occupation).
+
=item $departure->platform
Departure platform number (may not be a number).