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
|
package Travel::Status::DE::EFA::Trip;
use strict;
use warnings;
use 5.010;
use DateTime::Format::Strptime;
use Travel::Status::DE::EFA::Stop;
use parent 'Class::Accessor';
our $VERSION = '3.03';
Travel::Status::DE::EFA::Trip->mk_ro_accessors(
qw(operator product product_class name line number type id dest_name dest_id)
);
sub new {
my ( $obj, %conf ) = @_;
my $json = $conf{json}{transportation} // $conf{json}{leg}{transportation};
my $ref = {
operator => $json->{operator}{name},
product => $json->{product}{name},
product_class => $json->{product}{class},
polyline => $json->{coords},
name => $json->{name},
line => $json->{disassembledName},
number => $json->{properties}{trainNumber},
type => $json->{properties}{trainType} // $json->{product}{name},
id => $json->{id},
dest_name => $json->{destination}{name},
dest_id => $json->{destination}{id},
route_raw => $json->{locationSequence}
// $conf{json}{leg}{stopSequence},
strptime_obj => DateTime::Format::Strptime->new(
pattern => '%Y-%m-%dT%H:%M:%SZ',
time_zone => 'UTC'
),
};
if ( ref( $ref->{polyline} ) eq 'ARRAY' and @{ $ref->{polyline} } == 1 ) {
$ref->{polyline} = $ref->{polyline}[0];
}
return bless( $ref, $obj );
}
sub polyline {
my ( $self, %opt ) = @_;
if ( $opt{fallback} and not @{ $self->{polyline} // [] } ) {
# TODO add $_->{id} as well?
return map { $_->{latlon} } $self->route;
}
return @{ $self->{polyline} // [] };
}
sub parse_dt {
my ( $self, $value ) = @_;
if ($value) {
my $dt = $self->{strptime_obj}->parse_datetime($value);
if ($dt) {
return $dt->set_time_zone('Europe/Berlin');
}
}
return undef;
}
sub route {
my ($self) = @_;
if ( $self->{route} ) {
return @{ $self->{route} };
}
for my $stop ( @{ $self->{route_raw} // [] } ) {
my $chain = $stop;
my ( $platform, $place, $name, $name_full, $stop_id );
while ( $chain->{type} ) {
if ( $chain->{type} eq 'platform' ) {
$platform = $chain->{properties}{platformName}
// $chain->{properties}{platform};
}
elsif ( $chain->{type} eq 'stop' ) {
$name = $chain->{disassembledName};
$name_full = $chain->{name};
$stop_id = $chain->{properties}{stopId};
}
elsif ( $chain->{type} eq 'locality' ) {
$place = $chain->{name};
}
$chain = $chain->{parent};
}
push(
@{ $self->{route} },
Travel::Status::DE::EFA::Stop->new(
sched_arr => $self->parse_dt( $stop->{arrivalTimePlanned} ),
sched_dep => $self->parse_dt( $stop->{departureTimePlanned} ),
rt_arr => $self->parse_dt( $stop->{arrivalTimeEstimated} ),
rt_dep => $self->parse_dt( $stop->{departureTimeEstimated} ),
latlon => $stop->{coord},
full_name => $name_full,
name => $name,
place => $place,
niveau => $stop->{niveau},
platform => $platform,
id => $stop->{id},
stop_id => $stop_id,
)
);
}
delete $self->{route_raw};
return @{ $self->{route} // [] };
}
sub TO_JSON {
my ($self) = @_;
# lazy loading
$self->route;
my $ret = { %{$self} };
delete $ret->{strptime_obj};
return $ret;
}
1;
__END__
=head1 NAME
Travel::Status::DE::EFA::Trip - Information about an individual public transit
trip
=head1 SYNOPSIS
printf( "%s %s -> %s\n", $trip->type, $trip->line // q{}, $trip->dest_name );
for my $stop ( $trip->route ) {
...;
}
=head1 VERSION
version 3.03
=head1 DESCRIPTION
Travel::Status::DE::EFA::Trip describes a single trip / journey of a public
transport line.
=head1 METHODS
=head2 ACCESSORS
Most accessors return undef if the corresponding data is not available.
=over
=item $trip->operator
Operator name.
=item $trip->product
Product name.
=item $trip->product_class
Product class.
=item $trip->name
Trip or line name.
=item $trip->line
Line identifier. Note that this is not necessarily numeric.
=item $trip->number
Trip/journey number.
=item $trip->type
Transport / vehicle type, e.g. "RE" or "Bus".
=item $trip->id
Unique(?) trip ID
=item $trip->dest_name
Name of the trip's destination stop
=item $trip->dest_id
ID of the trip's destination stop
=item $trip->route
List of Travel::Status::DE::EFA::Stop(3pm) objects describing the route of this
trip.
Note: The EFA API requires a stop to be specified when requesting trip details.
The stops returned by this accessor appear to be limited to stops after the
requested stop; earlier ones may be missing.
=back
=head2 INTERNAL
=over
=item $trip = Travel::Status::DE::EFA::Trip->new(I<%data>)
Returns a new Travel::Status::DE::EFA::Trip object. You should not need to
call this.
=item $trip->TO_JSON
Allows the object data to be serialized to JSON.
=back
=head1 DIAGNOSTICS
None.
=head1 DEPENDENCIES
=over
=item Class::Accessor(3pm)
=item DateTime::Format::Strptime(3pm)
=item Travel::Status::DE::EFA::Stop(3pm)
=back
=head1 BUGS AND LIMITATIONS
This module is a Work in Progress.
Its API may change between minor versions.
=head1 SEE ALSO
Travel::Status::DE::EFA(3pm).
=head1 AUTHOR
Copyright (C) 2024 by Birte Kristina Friesel E<lt>derf@finalrewind.orgE<gt>
=head1 LICENSE
This module is licensed under the same terms as Perl itself.
|
