.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Travel::Routing::DE::EFA::Route::Part 3pm"
.TH Travel::Routing::DE::EFA::Route::Part 3pm "2020-05-03" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Travel::Routing::DE::EFA::Route::Part \- Describes one connection between two
points, without interchanges
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        for my $part ( $route\->parts ) {
\&
\&                if ( $part\->regular_notes ) {
\&                        say join( "\en", $part\->regular_notes );
\&                }
\&                if ( $part\->current_notes ) {
\&                        say join( "\en", map [ $_\->{summary} ] $part\->current_notes );
\&                }
\&
\&                printf(
\&                        "%s at %s \-> %s at %s, via %s to %s",
\&                        $part\->departure_time, $part\->departure_stop,
\&                        $part\->arrival_time,   $part\->arrival_stop,
\&                        $part\->train_line,     $part\->train_destination,
\&                );
\&        }
.Ve
.SH "VERSION"
.IX Header "VERSION"
version 2.19
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBTravel::Routing::DE::EFA::Route::Part\fR holds one specific connection (without
interchanges) between two points.  It specifies the start/stop point and time,
the train line and its destination, and optional additional data.
.PP
It is usually obtained by a call to \fBTravel::Routing::DE::EFA::Route\fR\|(3pm)'s
\&\fBparts\fR method.
.SH "METHODS"
.IX Header "METHODS"
.SS "\s-1ACCESSORS\s0"
.IX Subsection "ACCESSORS"
\&\*(L"Actual\*(R" in the description means that the delay (if available) is already
included in the calculation, \*(L"Scheduled\*(R" means it isn't.
.ie n .IP "$part\->arrival_stop" 4
.el .IP "\f(CW$part\fR\->arrival_stop" 4
.IX Item "$part->arrival_stop"
arrival stop (city name plus station name)
.ie n .IP "$part\->arrival_platform" 4
.el .IP "\f(CW$part\fR\->arrival_platform" 4
.IX Item "$part->arrival_platform"
arrival platform (either \*(L"Gleis x\*(R" or \*(L"Bstg. x\*(R")
.ie n .IP "$part\->arrival_stop_and_platform" 4
.el .IP "\f(CW$part\fR\->arrival_stop_and_platform" 4
.IX Item "$part->arrival_stop_and_platform"
\&\*(L"stop: platform\*(R" concatenation
.ie n .IP "$part\->arrival_date" 4
.el .IP "\f(CW$part\fR\->arrival_date" 4
.IX Item "$part->arrival_date"
Actual arrival date in \s-1DD.MM.YYYY\s0 format
.ie n .IP "$part\->arrival_time" 4
.el .IP "\f(CW$part\fR\->arrival_time" 4
.IX Item "$part->arrival_time"
Actual arrival time in \s-1HH:MM\s0 format
.ie n .IP "$part\->arrival_sdate" 4
.el .IP "\f(CW$part\fR\->arrival_sdate" 4
.IX Item "$part->arrival_sdate"
Scheduled arrival date in \s-1DD.MM.YYYY\s0 format
.ie n .IP "$part\->arrival_stime" 4
.el .IP "\f(CW$part\fR\->arrival_stime" 4
.IX Item "$part->arrival_stime"
Scheduled arrival time in \s-1HH:MM\s0 format
.ie n .IP "$part\->arrival_routemaps" 4
.el .IP "\f(CW$part\fR\->arrival_routemaps" 4
.IX Item "$part->arrival_routemaps"
List of URLs, may be empty. Each \s-1URL\s0 poinst to a transfer map for the arrival
station, usually outlining how to transfer from this train to the next one
(if applicable).
.ie n .IP "$part\->arrival_stationmaps" 4
.el .IP "\f(CW$part\fR\->arrival_stationmaps" 4
.IX Item "$part->arrival_stationmaps"
List of URLs, may be empty. Each \s-1URL\s0 points to an \s-1HTML\s0 map of the arrival
station.
.ie n .IP "$part\->current_notes" 4
.el .IP "\f(CW$part\fR\->current_notes" 4
.IX Item "$part->current_notes"
Remarks about unscheduled changes to the line serving this connaction part,
such as cancelled stops. Most times, the \s-1EFA\s0 service does not include this
information in its route calculations.
.Sp
Returns a list of \fBTravel::Routing::DE::EFA::Route::Message\fR\|(3pm) objects.
.ie n .IP "$part\->delay" 4
.el .IP "\f(CW$part\fR\->delay" 4
.IX Item "$part->delay"
delay in minutes, 0 if unknown
.ie n .IP "$part\->departure_stop" 4
.el .IP "\f(CW$part\fR\->departure_stop" 4
.IX Item "$part->departure_stop"
departure stop (city name plus station name)
.ie n .IP "$part\->departure_platform" 4
.el .IP "\f(CW$part\fR\->departure_platform" 4
.IX Item "$part->departure_platform"
departure platform (either \*(L"Gleis x\*(R" or \*(L"Bstg. x\*(R")
.ie n .IP "$part\->departure_stop_and_platform" 4
.el .IP "\f(CW$part\fR\->departure_stop_and_platform" 4
.IX Item "$part->departure_stop_and_platform"
\&\*(L"stop: platform\*(R" concatenation
.ie n .IP "$part\->departure_date" 4
.el .IP "\f(CW$part\fR\->departure_date" 4
.IX Item "$part->departure_date"
Actual departure date in \s-1DD.MM.YYYY\s0 format
.ie n .IP "$part\->departure_time" 4
.el .IP "\f(CW$part\fR\->departure_time" 4
.IX Item "$part->departure_time"
Actual departure time in \s-1HH:MM\s0 format
.ie n .IP "$part\->departure_sdate" 4
.el .IP "\f(CW$part\fR\->departure_sdate" 4
.IX Item "$part->departure_sdate"
Scheduled departure date in \s-1DD.MM.YYYY\s0 format
.ie n .IP "$part\->departure_stime" 4
.el .IP "\f(CW$part\fR\->departure_stime" 4
.IX Item "$part->departure_stime"
Scheduled departure time in \s-1HH:MM\s0 format
.ie n .IP "$part\->departure_routemaps" 4
.el .IP "\f(CW$part\fR\->departure_routemaps" 4
.IX Item "$part->departure_routemaps"
List of URLs, may be empty. Each \s-1URL\s0 points to a \s-1PDF\s0 a transfer map for the
departure station, usually outlining how to transfer from thep previous train
(if applicable) to this one.
.ie n .IP "$part\->departure_stationmaps" 4
.el .IP "\f(CW$part\fR\->departure_stationmaps" 4
.IX Item "$part->departure_stationmaps"
List of URLs, may be empty. Each \s-1URL\s0 poinst to an \s-1HTML\s0 map of the departure
station.
.ie n .IP "$part\->footpath_duration" 4
.el .IP "\f(CW$part\fR\->footpath_duration" 4
.IX Item "$part->footpath_duration"
Walking duration when transferring before / after / during this trip
in minutes. The meaning depends on the value of \fBfootpath_type\fR.
.ie n .IP "$part\->footpath_parts" 4
.el .IP "\f(CW$part\fR\->footpath_parts" 4
.IX Item "$part->footpath_parts"
Returns a list of [\fItype\fR, \fIlevel\fR] arrayrefs describing the
footpath. For instance, [\*(L"\s-1ESCALATOR\*(R", \*(L"UP\*(R"\s0], [\*(L"\s-1LEVEL\*(R", \*(L"LEVEL\*(R"\s0],
[\*(L"\s-1STAIRS\*(R", \*(L"UP\*(R"\s0] means first taking an escalator up, then walking a while,
and then taking a flight of stairs up again.
.Sp
The content of \fItype\fR and \fIlevel\fR comes directly from the \s-1EFA\s0 backend. At
the moment, the following values are known:
.RS 4
.IP "type: \s-1ESCALATOR, LEVEL, STAIRS\s0" 4
.IX Item "type: ESCALATOR, LEVEL, STAIRS"
.PD 0
.IP "level: \s-1DOWN, LEVEL, UP\s0" 4
.IX Item "level: DOWN, LEVEL, UP"
.RE
.RS 4
.RE
.ie n .IP "$part\->footpath_type" 4
.el .IP "\f(CW$part\fR\->footpath_type" 4
.IX Item "$part->footpath_type"
.PD
type of this footpath, passed through from the \s-1EFA\s0 backend. The value
\&\*(L"\s-1AFTER\*(R"\s0 indicates a footpath (transfer) after this route part. The value
\&\*(L"\s-1IDEST\*(R"\s0 indicates that this route part already is a footpath (aka a walking
connection between two stops), so the \fBfootpath\fR accessors contain redundant
information. Other values such as \*(L"\s-1BEFORE\*(R"\s0 may also be returned, but this is
unknown at this point.
.ie n .IP "$part\->is_cancelled" 4
.el .IP "\f(CW$part\fR\->is_cancelled" 4
.IX Item "$part->is_cancelled"
Returns true if this part of the route has been cancelled (i.e., the entire
route is probably useless), false otherwise.  For unknown reasons, \s-1EFA\s0 may
sometimes return routes which contain cancelled departures.
.ie n .IP "$part\->regular_notes" 4
.el .IP "\f(CW$part\fR\->regular_notes" 4
.IX Item "$part->regular_notes"
Remarks about the line serving this connaction part. Returns a list of
\&\fBTravel::Routing::DE::EFA::Route::Message\fR\|(3pm) objects.
.ie n .IP "$part\->train_destination" 4
.el .IP "\f(CW$part\fR\->train_destination" 4
.IX Item "$part->train_destination"
Destination of the line providing the connection. May be empty.
.ie n .IP "$part\->train_line" 4
.el .IP "\f(CW$part\fR\->train_line" 4
.IX Item "$part->train_line"
Name / number of the line. May be empty.
.ie n .IP "$part\->train_product" 4
.el .IP "\f(CW$part\fR\->train_product" 4
.IX Item "$part->train_product"
Usually the prefix of \fBtrain_line\fR, for instance \f(CW\*(C`U\-Bahn\*(C'\fR or
\&\f(CW\*(C`Niederflurstrab\*(C'\fR. However, it may also contain special values such as
\&\f(CW\*(C`Fu\*8weg\*(C'\fR (for a direct connection without transit vehicles) or
\&\f(CW\*(C`nicht umsteigen\*(C'\fR (in case a vehicle changes its line number at a stop).
In those cases, \fBtrain_destination\fR and \fBtrain_line\fR are usually empty.
.ie n .IP "$part\->via" 4
.el .IP "\f(CW$part\fR\->via" 4
.IX Item "$part->via"
Returns a list of \f(CW\*(C`[ "DD.MM.YYYY", "HH:MM", stop, platform ]\*(C'\fR arrayrefs
encoding the stops passed between \fBdeparture_stop\fR and \fBarrival_stop\fR,
if supported by the backend. Returns nothing / an empty list otherwise.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
None.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
.IP "\(bu" 4
\&\fBClass::Accessor\fR\|(3pm)
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
\&\f(CW$part\fR\->via does not work reliably.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBTravel::Routing::DE::EFA::Route::Message\fR\|(3pm), \fBTravel::Routing::DE::EFA\fR\|(3pm),
\&\fBClass::Accessor\fR\|(3pm).
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (C) 2011\-2017 by Daniel Friesel <derf@finalrewind.org>
.SH "LICENSE"
.IX Header "LICENSE"
This program is licensed under the same terms as Perl itself.