Newer
Older
package Travel::Status::DE::HAFAS::Stop;
# vim:foldmethod=marker
use strict;
use warnings;
use 5.014;
use parent 'Class::Accessor';
Travel::Status::DE::HAFAS::Stop->mk_ro_accessors(
qw(eva name lat lon distance_m weight));
# {{{ Constructor
sub new {
my ( $obj, %opt ) = @_;
my $loc = $opt{loc};
my $ref = {
name => $loc->{name},
lat => $loc->{crd}{y} * 1e-6,
lon => $loc->{crd}{x} * 1e-6,
weight => $loc->{wt},
distance_m => $loc->{dist},
};
if ( $opt{extra} ) {
while ( my ( $k, $v ) = each %{ $opt{extra} } ) {
$ref->{$k} = $v;
}
}
bless( $ref, $obj );
return $ref;
}
# }}}
sub TO_JSON {
my ($self) = @_;
my $ret = { %{$self} };
for my $k ( keys %{$ret} ) {
if ( ref( $ret->{$k} ) eq 'DateTime' ) {
$ret->{$k} = $ret->{$k}->epoch;
}
}
return $ret;
}
1;
__END__
=head1 NAME
Travel::Status::DE::HAFAS::Stop - Information about a HAFAS stop.
=head1 SYNOPSIS
# in geoSearch mode
for my $stop ($status->results) {
printf(
"%5.1f km %8d %s\n",
$result->distance_m * 1e-3,
$result->eva, $result->name
);
}
=head1 VERSION
=head1 DESCRIPTION
Travel::Status::DE::HAFAS::Stop describes a HAFAS stop. It may be part of a
journey or part of a geoSearch / locationSearch request.
Journey-, geoSearch- and locationSearch-specific accessors are annotated
accordingly and return undef in other contexts.
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
=head1 METHODS
=head2 ACCESSORS
=over
=item $stop->name
Stop name, e.g. "Essen Hbf" or "Unter den Linden/B75, Tostedt".
=item $stop->eva
EVA ID, e.g. 8000080.
=item $stop->lat
Stop latitude (WGS-84)
=item $stop->lon
Stop longitude (WGS-84)
=item $stop->distance_m (geoSearch)
Distance in meters between the requested coordinates and this stop.
=item $stop->weight
Weight / Relevance / Importance of this stop using an unknown metric.
Higher values indicate more relevant stops.
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
=item $stop->rt_arr (journey)
DateTime object for actual arrival.
=item $stop->sched_arr (journey)
DateTime object for scheduled arrival.
=item $stop->arr (journey)
DateTime object for actual or scheduled arrival.
=item $stop->arr_delay (journey)
Arrival delay in minutes.
=item $stop->arr_cancelled (journey)
Arrival is cancelled.
=item $stop->rt_dep (journey)
DateTime object for actual departure.
=item $stop->sched_dep (journey)
DateTime object for scheduled departure.
=item $stop->dep (journey)
DateTIme object for actual or scheduled departure.
=item $stop->dep_delay (journey)
Departure delay in minutes.
=item $stop->dep_cancelled (journey)
Departure is cancelled.
=item $stop->delay (journey)
Departure or arrival delay in minutes.
=item $stop->direction (journey)
Direction signage from this stop on, undef if unchanged.
=item $stop->rt_platform (journey)
Actual platform.
=item $stop->sched_platform (journey)
Scheduled platform.
=item $stop->platform (journey)
Actual or scheduled platform.
=item $stop->is_changed_platform (journey)
True if real-time and scheduled platform disagree.
=item $stop->load (journey)
Expected utilization / passenger load from this stop on.
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
=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) 2023 by Birthe Friesel E<lt>derf@finalrewind.orgE<gt>
=head1 LICENSE
This module is licensed under the same terms as Perl itself.