diff options
| author | Daniel Friesel <derf@finalrewind.org> | 2019-10-19 10:56:03 +0200 |
|---|---|---|
| committer | Daniel Friesel <derf@finalrewind.org> | 2019-10-19 10:56:03 +0200 |
| commit | e2eda73b852a8091bbb150b99ee13a338872d804 (patch) | |
| tree | 22c4aa5f52ecfb743165bb5bdb8c1089f60ef958 | |
| parent | 2aad0dfc2d50e8d7da5988ab73b314f19506aa86 (diff) | |
Document $status->related_stations
| -rw-r--r-- | lib/Travel/Status/DE/IRIS.pm | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/IRIS.pm b/lib/Travel/Status/DE/IRIS.pm index ddc53f6..a6111a4 100644 --- a/lib/Travel/Status/DE/IRIS.pm +++ b/lib/Travel/Status/DE/IRIS.pm @@ -718,6 +718,17 @@ departures for all related stations. In case of a fatal HTTP request or IRIS error, returns a string describing it. Returns undef otherwise. +=item $status->related_stations + +Returns a list of hashes describing related stations whose +arrivals/departures are included in B<results>. Only useful when setting +B<with_related> to a true value, see its documentation above for details. + +Each hash contains the keys B<uic> (UIC/EVA number; known as IBNR in Germany), +B<name> (station name), and B<ds100> (station code). Note that stations +returned by B<related_stations> are not necessarily known to +Travel::Status::DE::IRIS::Stations(3pm). + =item $status->results Returns a list of Travel::Status::DE::IRIS::Result(3pm) objects, each one describing |