summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDaniel Friesel <daniel.friesel@uos.de>2023-01-24 20:09:00 +0100
committerDaniel Friesel <daniel.friesel@uos.de>2023-01-24 20:09:00 +0100
commit48c69450d431df7fb3773fa36a27fb3093914f9f (patch)
tree18ea51a1fa4ccbe3226d44bcd79e772913a6860c /lib
parentc9ea85b0c49e54d849219daf0677fa9235f8f70f (diff)
Journey: document station / station_uic / route_interesting
Diffstat (limited to 'lib')
-rw-r--r--lib/Travel/Status/DE/HAFAS/Journey.pm14
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/HAFAS/Journey.pm b/lib/Travel/Status/DE/HAFAS/Journey.pm
index a093f98..10c80fa 100644
--- a/lib/Travel/Status/DE/HAFAS/Journey.pm
+++ b/lib/Travel/Status/DE/HAFAS/Journey.pm
@@ -530,6 +530,14 @@ service notices (e.g. "missing carriage") or detailed delay reasons
Returns the operator responsible for this journey. Returns undef
if the backend does not provide an operator.
+=item $journey->station (station only)
+
+Name of the station at which this journey was requested.
+
+=item $journey->station_uic (station only)
+
+UIC/EVA ID of the station at which this journey was requested.
+
=item $journey->route
Returns a list of hashes; each hash describes a single journey stop.
@@ -577,6 +585,12 @@ entire route. Each hash contains the following keys:
Individual entries may be undef.
+=item $journey->route_interesting([I<count>])
+
+Return up to I<count> (default: B<3>) parts of C<< $journey->route >> that may
+be particularly helpful, e.g. main stations or airports.
+Returns a list of hashes, see above for the layout.
+
=item $journey->route_end
Name of the last route station. In arrival mode, this is where the train