The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

NAME

Travel::Status::DE::DBRIS::Journey - Information about a single journey received by Travel::Status::DE::DBRIS

SYNOPSIS

my $status = Travel::Status::DE::DBRIS->new(journey => ...);
my $journey = $status->result;

VERSION

version 0.11

DESCRIPTION

Travel::Status::DE::DBRIS::Journey describes a single journey that was obtained by passing the journey key to Travel::Status::DE::DBRIS->new or ->new_p.

METHODS

ACCESSORS

$journey->day

DateTime(3pm) object encoding the day on which this journey departs at its origin station.

$journey->id

Trip ID / journey ID, i.e., the argument passed to Travel::Status::DE::DBRIS->new's journey key.

$journey->train

Textual description of the departure, typically consisting of type identifier (e.g. S, U) and line or trip number.

$journey->train_no

Trip number, if available. undef otherwise.

$journey->line_no

Line identifier, if available. undef otherwise. Note that the line identifier is not necessarily numeric.

$journey->type

Trip type, e.g. S (S-Bahn) or U (U-Bahn / subway). undef if unknown.

$journey->is_cancelled

True if this trip has been cancelled, false/undef otherwise.

$journey->polyline

List of geocoordinates that describe the trip's route. Only available if the DBRIS constructor was called with with_polyline set to a true value. Each list entry is a hash with the following keys.

  • lon (longitude)

  • lat (latitude)

  • stop (Travel::Status::DE::DBRIS::Location(3pm) object describing the stop at this location, if any)

The stop keys are only available if the optional dependency GIS::Distance(3pm) is available. Note that the lon and lat keys in a referenced stop may differ from the lon and lat keys in a polyline entry.

$journey->route

List of Travel::Status::DE::DBRIS::Location(3pm) objects that describe individual stops along the trip.

$journey->attributes

List of attributes associated with this trip. Each list entry is a hashref with some or all of the following keys.

  • value (textual description of attribute)

  • teilstreckenHinweis (text describing that this attribute only applies to part of the trip's route)

$journey->messages

List of attributes associated with this trip. Each list entry is a hashref with some or all of the following keys.

  • prioritaet (priority, e.g. HOCH or NIEDRIG)

  • ueberschrift (headline)

  • text (message text)

DIAGNOSTICS

None.

DEPENDENCIES

Class::Accessor(3pm)
GIS::Distance(3pm)

Optional, required for stop keys in polyline entries.

BUGS AND LIMITATIONS

None known.

SEE ALSO

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

AUTHOR

Copyright (C) 2025 by Birte Kristina Friesel <derf@finalrewind.org>

LICENSE

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