1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
package Travel::Status::DE::VRR::Result;
use strict;
use warnings;
use 5.010;
use parent 'Class::Accessor';
our $VERSION = '1.04';
Travel::Status::DE::VRR::Result->mk_ro_accessors(
qw(countdown date delay destination is_cancelled info key line lineref platform
platform_db sched_date sched_time time type)
);
sub new {
my ( $obj, %conf ) = @_;
my $ref = \%conf;
if ($ref->{delay} eq '-9999') {
$ref->{delay} = 0;
$ref->{is_cancelled} = 1;
}
else {
$ref->{is_cancelled} = 0;
}
return bless( $ref, $obj );
}
sub TO_JSON {
my ($self) = @_;
return { %{$self} };
}
1;
__END__
=head1 NAME
Travel::Status::DE::VRR::Result - Information about a single
departure received by Travel::Status::DE::VRR
=head1 SYNOPSIS
for my $departure ($status->results) {
printf(
"At %s: %s to %s from platform %s\n",
$departure->time, $departure->line, $departure->destination,
$departure->platform
);
}
=head1 VERSION
version 1.04
=head1 DESCRIPTION
Travel::Status::DE::VRR::Result describes a single departure as obtained by
Travel::Status::DE::VRR. It contains information about the time, platform,
line number and destination.
=head1 METHODS
=head2 ACCESSORS
"Actual" in the description means that the delay (if available) is already
included in the calculation, "Scheduled" means it isn't.
=over
=item $departure->countdown
Actual time in minutes from now until the tram/bus/train will depart.
If delay information is available, it is already included.
=item $departure->date
Actual departure date (DD.MM.YYYY).
=item $departure->delay
Expected delay from scheduled departure time in minutes. A delay of 0
indicates either departure on time or that no delay information is available.
=item $departure->destination
Destination name.
=item $departure->info
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. If no information is available, returns
an empty string.
=item $departure->is_cancelled
1 if the departure got cancelled, 0 otherwise.
=item $departure->key
Unknown. Unlike the name may suggest, this is not a unique key / UUID for a
departure: On the same day, different lines departing at the same station
may have the same key. It might, however, be unique when combined with the
B<line> information.
=item $departure->line
The name/number of the line.
=item $departure->lineref
Travel::Status::DE::VRR::Line(3pm) object describing the departing line in
detail.
=item $departure->platform
Departure platform number.
=item $departure->platform_db
true if the platform number is operated by DB ("Gleis x"), false ("Bstg. x")
otherwise.
Unfortunately, there is no distinction between tram and bus platforms yet,
which also may have the same numbers.
=item $departure->sched_date
Scheduled departure date (DD.MM.YYYY).
=item $departure->sched_time
Scheduled departure time (HH:MM).
=item $departure->time
Actual departure time (HH:MM).
=item $departure->type
Type of the departure. Note that efa.vrr.de sometimes puts bogus data in this
field. See L</DEPARTURE TYPES>.
=back
=head2 INTERNAL
=over
=item $departure = Travel::Status::DE::VRR::Result->new(I<%data>)
Returns a new Travel::Status::DE::VRR::Result object. You should not need to
call this.
=item $departure->TO_JSON
Allows the object data to be serialized to JSON.
=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 * StraE<szlig>enbahn
=item * U-Bahn
=back
=head1 DIAGNOSTICS
None.
=head1 DEPENDENCIES
=over
=item Class::Accessor(3pm)
=back
=head1 BUGS AND LIMITATIONS
C<< $result->type >> may contain bogus data. This comes from the efa.vrr.de
interface.
=head1 SEE ALSO
Travel::Status::DE::VRR(3pm).
=head1 AUTHOR
Copyright (C) 2011 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>
=head1 LICENSE
This module is licensed under the same terms as Perl itself.
|
