.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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::Message 3pm"
.TH Travel::Routing::DE::EFA::Route::Message 3pm "2015-10-25" "perl v5.20.2" "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::Message \- contains a message related to a
route or route part.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&    for my $m ($routepart\->regular_notes, $routepart\->current_notes) {
\&        if ($m\->is_detailed) {
\&            printf("%s: %s\en", $m\->subtitle, $m\->subject);
\&        }
\&        else {
\&            say $m\->summary;
\&        }
\&    }
.Ve
.SH "VERSION"
.IX Header "VERSION"
version 2.14
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBTravel::Routing::DE::EFA::Route::Message\fR contains information about a
specific route or route part, such as wheelchair accessibility, unscheduled
route diversions and cancelled stops. Often, this information is not used in
the backend's route calculation, so a message may invalidate a certain route or
route part.
.PP
There are two types of messages provided by the backend: oneliners and detailed
messages. There is no known distinction regarding their type or content.
Also, there are some other backend-provided fields not yet covered by this
module, so expect changes in future releases.
.PP
A oneline message consists of a single string which can be accesed using
\&\fBsubject\fR or \fBsummary\fR and its \fBis_detailed\fR accessor returns false.
.PP
A detailed message has a subject, subtitle, summary and detailed \s-1HTML\s0
content.
.SH "METHODS"
.IX Header "METHODS"
.SS "\s-1ACCESSORS\s0"
.IX Subsection "ACCESSORS"
.ie n .IP "$message\->is_detailed" 4
.el .IP "\f(CW$message\fR\->is_detailed" 4
.IX Item "$message->is_detailed"
True if all accessors (fields) are set, false otherwise. When this field
is false, only \fBsummary\fR and \fBsubject\fR are set (and they will return the
same string).
.ie n .IP "$message\->summary" 4
.el .IP "\f(CW$message\fR\->summary" 4
.IX Item "$message->summary"
Message summary.
.ie n .IP "$message\->subject" 4
.el .IP "\f(CW$message\fR\->subject" 4
.IX Item "$message->subject"
Message subject. May be the same string as the subtitle.
.ie n .IP "$message\->subtitle" 4
.el .IP "\f(CW$message\fR\->subtitle" 4
.IX Item "$message->subtitle"
Message subtitle. May be the same string as the summary.
.ie n .IP "$message\->raw_content" 4
.el .IP "\f(CW$message\fR\->raw_content" 4
.IX Item "$message->raw_content"
Raw \s-1HTML\s0 content. May contain information not available via any other
accessor.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
None.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
None.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
This module does not yet provide access to all data provided by the backend.
Most notably, \fBraw_content\fR is not properly parsed yet.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fITravel::Routing::DE::EFA\fR\|(3pm), \fITravel::Routing::DE::EFA::Route::Part\fR\|(3pm).
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (C) 2015 by Daniel Friesel <derf@finalrewind.org>
.SH "LICENSE"
.IX Header "LICENSE"
.Vb 1
\&  0. You just DO WHAT THE FUCK YOU WANT TO.
.Ve