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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
package Travel::Status::DE::HAFAS::Result;
use strict;
use warnings;
use 5.010;
no if $] >= 5.018, warnings => 'experimental::smartmatch';
use parent 'Class::Accessor';
our $VERSION = '1.05';
Travel::Status::DE::HAFAS::Result->mk_ro_accessors(
qw(date info raw_e_delay raw_delay time train route_end info_raw));
sub new {
my ( $obj, %conf ) = @_;
my $ref = \%conf;
return bless( $ref, $obj );
}
sub delay {
my ($self) = @_;
if ( defined $self->{raw_e_delay} ) {
return $self->{raw_e_delay};
}
if ( defined $self->{raw_delay}
and $self->{raw_delay} ne q{-}
and $self->{raw_delay} ne 'cancel' )
{
return $self->{raw_delay};
}
return;
}
sub destination {
my ($self) = @_;
return $self->{route_end};
}
sub line {
my ($self) = @_;
return $self->{train};
}
sub is_cancelled {
my ($self) = @_;
if ( $self->{raw_delay} and $self->{raw_delay} eq 'cancel' ) {
return 1;
}
return 0;
}
sub is_changed_platform {
my ($self) = @_;
if ( defined $self->{new_platform} and defined $self->{platform} ) {
if ( $self->{new_platform} ne $self->{platform} ) {
return 1;
}
return 0;
}
if ( defined $self->{net_platform} ) {
return 1;
}
return 0;
}
sub messages {
my ($self) = @_;
if ( $self->{messages} ) {
return @{ $self->{messages} };
}
return;
}
sub origin {
my ($self) = @_;
return $self->{route_end};
}
sub platform {
my ($self) = @_;
return $self->{new_platform} // $self->{platform};
}
sub TO_JSON {
my ($self) = @_;
return { %{$self} };
}
sub type {
my ($self) = @_;
# $self->{train} is either "TYPE 12345" or "TYPE12345"
my ($type) = ( $self->{train} =~ m{ ^ ([[:upper:]]+) }x );
return $type;
}
1;
__END__
=head1 NAME
Travel::Status::DE::HAFAS::Result - Information about a single
arrival/departure received by Travel::Status::DE::HAFAS
=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,
);
}
# or (depending on module setup)
for my $arrival ($status->results) {
printf(
"At %s: %s from %s on platform %s\n",
$arrival->time,
$arrival->line,
$arrival->origin,
$arrival->platform,
);
}
=head1 VERSION
version 1.05
=head1 DESCRIPTION
Travel::Status::DE::HAFAS::Result describes a single arrival/departure
as obtained by Travel::Status::DE::HAFAS. It contains information about
the platform, time, route and more.
=head1 METHODS
=head2 ACCESSORS
=over
=item $result->date
Arrival/Departure date in "dd.mm.yyyy" format.
=item $result->delay
Returns the train's delay in minutes, or undef if it is unknown.
Also returns undef if the train has been cancelled.
=item $result->info
Returns additional information, for instance the most recent delay reason.
Returns an empty string if no (useful) information is available.
=item $result->is_cancelled
True if the train was cancelled, false otherwise.
=item $result->is_changed_platform
True if the platform (as returned by the B<platform> accessor) is not the
scheduled one. Note that the scheduled platform is unknown in this case.
=item $result->messages
Returns a list of message strings related to this train. Messages usually are
service notices (e.g. "missing carriage") or detailed delay reasons
(e.g. "switch damage between X and Y, expect delays").
=item $result->line
=item $result->train
Returns the line name, either in a format like "S 1" (S-Bahn line 1)
or "RE 10111" (RegionalExpress train 10111, no line information).
=item $result->platform
Returns the platform from which the train will depart / at which it will
arrive. Realtime data if available, schedule data otherwise.
=item $result->route_end
Returns the last element of the route. Depending on how you set up
Travel::Status::DE::HAFAS (arrival or departure listing), this is
either the train's destination or its origin station.
=item $result->destination
=item $result->origin
Convenience aliases for C<< $result->route_end >>.
=item $result->time
Returns the arrival/departure time as string in "hh:mm" format.
=item $result->type
Returns the type of this train, e.g. "S" for S-Bahn, "RE" for Regional Express
or "ICE" for InterCity-Express.
=back
=head2 INTERNAL
=over
=item $result = Travel::Status::DE::HAFAS::Result->new(I<%data>)
Returns a new Travel::Status::DE::HAFAS::Result object.
You usually do not need to call this.
Required I<data>:
=over
=item B<time> => I<hh:mm>
=item B<train> => I<string>
=item B<route_end> => I<string>
=item B<platform> => I<string>
=item B<info_raw> => I<string>
=back
=back
=head1 DIAGNOSTICS
None.
=head1 DEPENDENCIES
=over
=item Class::Accessor(3pm)
=back
=head1 BUGS AND LIMITATIONS
None known.
=head1 SEE ALSO
Travel::Status::DE::HAFAS(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.
|