NAME

Travel::Status::DE::HAFAS::Message - An arrival/departure-related message.

SYNOPSIS

        if ($message->text) {
                printf("%s: %s\n", $message->short, $message->text);
        }
        else {
                say $message->short;
        }

VERSION

version 6.03

DESCRIPTION

Travel::Status::DE::HAFAS::Message describes a message belonging to an arrival or departure. Messages may refer to planned schedule changes due to construction work, the expected passenger volume, or similar.

METHODS

ACCESSORS

$message->short

Message header. May be a concise single-sentence summary or a mostly useless string such as "Information". Does not contain newlines.

$message->text

Detailed message content. Does not contain newlines.

$message->code

Two-digit message code, seems to be only used with messages of type "A". Details unknown.

$message->type

A single character indicating the message type. The following types are known:

A

Generic information about a specific trip such as "WiFi available", "air conditioning", "DB tickets are not valid here", or "from here on as [line] towards [destination]".

C

"Current information available", "Journey cancelled", "connection may not be caught", possibly more.

D

Large-scale disruption, e.g. medical emergency on line.

G

Platform change, possibly more.

H

Misc stuff such as "Journey contains trains with mandatory reservation" or "ICE Sprinter".

L

Replacement journey

M

Free-text infos about construction sites, broken elevators, large events and similar occasions.

P

Journey has been cancelled, possibly more.

$message->ref_count

Counter indicating how often this message is used by the requested arrivals/departures. ref_count is an integer between 1 and the number of results. If ref_count is 1, it is referenced by a single result only.

$message->is_him

True if it is a HIM message (typically used for service information), false if not (message may be a REM instead, indicating e.g. presence of a bicycle carriage or WiFi).

DIAGNOSTICS

None.

DEPENDENCIES

Class::Accessor(3pm)

BUGS AND LIMITATIONS

None known.

SEE ALSO

Travel::Status::DE::HAFAS(3pm).

AUTHOR

Copyright (C) 2020-2023 by Birte Kristina Friesel <derf@finalrewind.org>

LICENSE

This module is licensed under the same terms as Perl itself.