summaryrefslogtreecommitdiff
path: root/lib/Travel/Status
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2023-01-27 18:14:14 +0100
committerDaniel Friesel <derf@finalrewind.org>2023-01-27 18:14:14 +0100
commit1c421e57a73fd6aa752887ae715631b40862c828 (patch)
tree9d424cce2bb2fa8755b462f46dcea1cc98e02973 /lib/Travel/Status
parent7aea72f583d2eb9576f2cdfe137864d5583bbc51 (diff)
Document $status->station
Diffstat (limited to 'lib/Travel/Status')
-rw-r--r--lib/Travel/Status/DE/HAFAS.pm12
-rw-r--r--lib/Travel/Status/DE/HAFAS/Journey.pm1
2 files changed, 13 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/HAFAS.pm b/lib/Travel/Status/DE/HAFAS.pm
index 2d9ba87..6e9f3e2 100644
--- a/lib/Travel/Status/DE/HAFAS.pm
+++ b/lib/Travel/Status/DE/HAFAS.pm
@@ -928,6 +928,18 @@ If no result was found or the parser / http request failed, returns undef.
Returns a list of Travel::Status::DE::HAFAS::Message(3pm) objects with
service messages. Each message belongs to at least one arrival/departure.
+=item $status->station
+
+Returns a hashref describing the most common departure station in all requested
+journeys. Note that this may be different from the station for which departures
+were requested, as HAFAS uses different identifiers for train stations, bus
+stops, and other modes of transit even if they are interlinked.
+
+The hashref contains two entries: B<name> (station name) and B<uic> (UIC / EVA
+ID). These are subject to change.
+
+Not available in journey mode.
+
=item $status->similar_stops
Returns a list of hashrefs describing stops whose name is similar to the one
diff --git a/lib/Travel/Status/DE/HAFAS/Journey.pm b/lib/Travel/Status/DE/HAFAS/Journey.pm
index 2faaf92..06a71df 100644
--- a/lib/Travel/Status/DE/HAFAS/Journey.pm
+++ b/lib/Travel/Status/DE/HAFAS/Journey.pm
@@ -547,6 +547,7 @@ 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.
+May be renamed in future releases.
=item $journey->route