From 556f259834d75cad6a2feeb1c5106204d5921a28 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Wed, 9 Sep 2015 22:57:17 +0200 Subject: Squashed commit of the following: commit 73bb123b4a90dab9a08fa38555f0cd4afcdf3740 Author: Daniel Friesel Date: Wed Sep 9 21:08:51 2015 +0200 remove outdated and now unused tests commit 3f35ba0001aaff49a7b10acfaa83303b354c162a Author: Daniel Friesel Date: Wed Sep 9 21:07:34 2015 +0200 documentation for ::DeutscheBahn commit f4c66605dcbffedbb558ca66c5032e5252011244 Author: Daniel Friesel Date: Wed Sep 9 21:03:31 2015 +0200 re-add deutschebahn module commit 41b505bc98d4b25a7ca15465fe0bbee6c3708e9e Author: Daniel Friesel Date: Tue Sep 8 18:31:22 2015 +0200 more documentation updates commit edf7b5fbd8175b4b53735859b2a961fe6ab8cf49 Author: Daniel Friesel Date: Sun Sep 6 18:48:09 2015 +0200 improve delay and delayReason handling commit c4e9121a181de9d800226ab6fccca8abb8b14705 Author: Daniel Friesel Date: Sun Sep 6 18:22:23 2015 +0200 HAFAS.pm: Code cleanup commit edae36b16ecc5e1fa0adbece954bb348ce37e9a0 Author: Daniel Friesel Date: Sun Sep 6 13:31:46 2015 +0200 add devmode option commit f7a60ae80e59a129aae77b276925f80d7430c259 Author: Daniel Friesel Date: Sun Sep 6 01:18:28 2015 +0200 support for platform changes commit 6876d56e6dd22065c342fe1fbf42f9fcf7f3d457 Author: Daniel Friesel Date: Thu Aug 20 20:01:24 2015 +0200 documentation: DeutscheBahn -> HAFAS commit 73706f0150bd0fb9c11d2b8be89204bfd4b03235 Author: Daniel Friesel Date: Thu Aug 20 19:54:12 2015 +0200 routes and route_info are not supported here commit af8a541fd1f03131a9cd39a5548188dbc09b266a Author: Daniel Friesel Date: Thu Aug 20 19:50:35 2015 +0200 documentationfoo commit ff3f2298c7be86bb7b672359f54c39588706673e Author: Daniel Friesel Date: Thu Aug 20 19:14:30 2015 +0200 rename db-ris to hafas-m commit 754fda9974e20ee630a3a3386d6ff7c42468ca46 Author: Daniel Friesel Date: Thu Aug 20 17:18:12 2015 +0200 add support for cancelled trains and delay reasons commit f860183613ee7818a2f448e8c40bbbdb95c6180a Author: Daniel Friesel Date: Wed Aug 19 15:19:54 2015 +0200 add info message support commit 17eda1d00cdbf98a04dbbe7d3ff89c6833af016d Author: Daniel Friesel Date: Sun Aug 16 18:00:05 2015 +0200 initial hafas api support --- lib/Travel/Status/DE/HAFAS/Result.pm | 277 +++++++++++++++++++++++++++++++++++ 1 file changed, 277 insertions(+) create mode 100644 lib/Travel/Status/DE/HAFAS/Result.pm (limited to 'lib/Travel/Status/DE/HAFAS/Result.pm') diff --git a/lib/Travel/Status/DE/HAFAS/Result.pm b/lib/Travel/Status/DE/HAFAS/Result.pm new file mode 100644 index 0000000..f2aee63 --- /dev/null +++ b/lib/Travel/Status/DE/HAFAS/Result.pm @@ -0,0 +1,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 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: + +=over + +=item B