summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2011-11-26 18:10:58 +0100
committerDaniel Friesel <derf@finalrewind.org>2011-11-26 18:10:58 +0100
commite1a7eefbb36126b925e78b9f7acd3ac9a086e85c (patch)
tree153bdb594ce126000e5ffb9848301090dd78ba5b /lib
parent1f0fbaad004576a7b9350f0a0994889b46428497 (diff)
VRR.pm / Result.pm: Fix ->lines and ->type documentation
Diffstat (limited to 'lib')
-rw-r--r--lib/Travel/Status/DE/VRR.pm11
-rw-r--r--lib/Travel/Status/DE/VRR/Result.pm38
2 files changed, 43 insertions, 6 deletions
diff --git a/lib/Travel/Status/DE/VRR.pm b/lib/Travel/Status/DE/VRR.pm
index 4617cbf..5fdef27 100644
--- a/lib/Travel/Status/DE/VRR.pm
+++ b/lib/Travel/Status/DE/VRR.pm
@@ -300,6 +300,7 @@ sub results {
my $info = $e_info->textContent;
my $countdown = $e->getAttribute('countdown');
my $delay = $e_info->getAttribute('delay') // 0;
+ my $type = $e_info->getAttribute('name');
my $platform_is_db = 0;
@@ -326,6 +327,7 @@ sub results {
delay => $delay,
sched_date => $date,
sched_time => $time,
+ type => $type,
)
);
}
@@ -404,8 +406,13 @@ address / poi / stop name to list departures for.
=item $status->errstr
-In case of an error in the HTTP requests, returns a string describing it. If
-no error occured, returns undef.
+In case of en HTTP request or EFA error, returns a string describing it. If
+none occured, returns undef.
+
+=item $status->lines
+
+Returns a list of Travel::Status::DE::VRR::Line(3pm) objects, each one
+describing one line servicing the selected station.
=item $status->results
diff --git a/lib/Travel/Status/DE/VRR/Result.pm b/lib/Travel/Status/DE/VRR/Result.pm
index f65cfb1..ae352e0 100644
--- a/lib/Travel/Status/DE/VRR/Result.pm
+++ b/lib/Travel/Status/DE/VRR/Result.pm
@@ -83,7 +83,8 @@ Destination name.
Additional information related to the departure (string). If departures for
an address were requested, this is the stop name, otherwise it may be recent
-news related to the line's schedule.
+news related to the line's schedule. If no information is available, returns
+an empty string.
=item $departure->line
@@ -120,8 +121,8 @@ Actual departure time (HH:MM).
=item $departure->type
-Type of the departing train, values observed so far are "StraE<szlig>enbahn",
-"Bus", "NE", "S-Bahn" and "U-Bahn".
+Type of the departure. Note that efa.vrr.de sometimes puts bogus data in this
+field. See L</DEPARTURE TYPES>.
=back
@@ -136,6 +137,34 @@ call this.
=back
+=head1 DEPARTURE TYPES
+
+The following are known so far:
+
+=over
+
+=item * Abellio-Zug
+
+=item * Eurocity
+
+=item * Intercity-Express
+
+=item * NE (NachtExpress / night bus)
+
+=item * Niederflurbus
+
+=item * R-Bahn (RE / RegionalExpress)
+
+=item * S-Bahn
+
+=item * SB (Schnellbus)
+
+=item * Stra├čenbahn
+
+=item * U-Bahn
+
+=back
+
=head1 DIAGNOSTICS
None.
@@ -150,7 +179,8 @@ None.
=head1 BUGS AND LIMITATIONS
-Not all possible B<type> values are documented yet.
+C<< $result->type >> may contain bogus data. This comes from the efa.vrr.de
+interface.
=head1 SEE ALSO