DBWagenreihung(3pm): wagon order → carriage formation

	return @{ $self->{wagongroups} // [] };

	return @{ $self->{wagongroups} // [] };

}

}

sub carriages {

	my ($self) = @_;

	return @{ $self->{wagons} // [] };

}

sub wagons {

sub wagons {

	my ($self) = @_;

	my ($self) = @_;

	return @{ $self->{wagons} // [] };

	return @{ $self->{wagons} // [] };

=head1 NAME

=head1 NAME

Travel::Status::DE::DBWagenreihung - Interface to Deutsche Bahn Wagon Order API.

Travel::Status::DE::DBWagenreihung - Interface to Deutsche Bahn carriage formation API.

=head1 SYNOPSIS

=head1 SYNOPSIS

        train_number => 1234,

        train_number => 1234,

    );

    );

    for my $wagon ( $wr->wagons ) {

    for my $carriage ( $wr->carriages ) {

        printf("Wagen %s: Abschnitt %s\n", $wagon->number // '?', $wagon->section);

        printf("Wagen %s: Abschnitt %s\n", $carriage->number // '?', $carriage->section);

    }

    }

=head1 VERSION

=head1 VERSION

=head1 DESCRIPTION

=head1 DESCRIPTION

Travel:Status:DE::DBWagenreihung is an unofficial interface to the Deutsche

Travel:Status:DE::DBWagenreihung is an unofficial interface to the Deutsche

Bahn Wagon Order API at L<https://www.apps-bahn.de/wr/wagenreihung/1.0>.  It

Bahn carriage formation API at L<https://ist-wr.noncd.db.de/wagenreihung/1.0>.

returns station-specific wagon orders for long-distance trains operated by

It returns station-specific carriage formations for a variety of trains in the

Deutsche Bahn. Data includes wagon positions on the platform, the ICE series,

rail network associated with Deutsche Bahn.  Data includes carriage positions

wagon-specific attributes such as first/second class or family coaches, and the

on the platform, train type (e.g. ICE series), carriage-specific attributes

internal type and number of each wagon.

such as first/second class, and the internal type and number of each carriage.

Positions on the platform are given both in meters and per cent (relative to

Positions on the platform are given both in meters and percent (relative to

platform length).

platform length).

At the time of this writing, only ICE trains are officially supported by the

Note that carriage formation data reported by the API is known to be bogus

backend, and even then glitches may occur. IC/EC trains are not officially

from time to time. This module does not perform thorough sanity checking.

supported; reported wagon orders may be correct, may lack unscheduled changes,

or may be completely bogus.

=head1 METHODS

=head1 METHODS

=item my $wr = Travel::Status::DE::DBWagenreihung->new(I<%opts>)

=item my $wr = Travel::Status::DE::DBWagenreihung->new(I<%opts>)

Requests wagon order for a specific train at a specific scheduled departure

Requests carriage formation for a specific train at a specific scheduled

time and date, which implicitly encodes the requested station. Use

departure time and date, which implicitly encodes the requested station. Use

L<Travel::Status::DE::IRIS> or similar to map station name and train number

L<Travel::Status::DE::IRIS> or similar to map station name and train number to

to scheduled departure.

scheduled departure.

Arguments:

Arguments:

=item B<departure> => I<datetime-obj> | I<YYYYMMDDhhmm>

=item B<departure> => I<datetime-obj> | I<YYYYMMDDhhmm>

Scheduled departure at the station of interested. Must be either a

Scheduled departure at the station of interest. Must be either a

L<DateTime> object or a string in YYYYMMDDhhmm format. Mandatory.

L<DateTime> object or a string in I<YYYYMMDDhhmm> format. Mandatory.

=item B<train_number> => I<number>

=item B<train_number> => I<number>

=item $wr->destinations

=item $wr->destinations

Returns a list describing the destinations of this train's wagons. In most

Returns a list describing the destinations of this train's carriages. In most

cases, it contains one element. For trains consisting of multiple wings or

cases, it contains one element. For trains consisting of multiple wings or

trains that switch locomotives along the way, it contains one element for each

trains that switch locomotives along the way, it contains one element for each

wing or other kind of wagon group.

wing or other kind of carriage group.

Each destination is a hash ref containing its B<name> and the corresponding

Each destination is a hash ref containing its B<name> and the corresponding

platform I<sections> (at the moment, this is a list of section identifiers).

platform I<sections> (at the moment, this is a list of section identifiers).

=item $wr->origins

=item $wr->origins

Returns a list describing the origins of this train's wagons. In most

Returns a list describing the origins of this train's carriages. In most

cases, it contains one element. For trains consisting of multiple wings or

cases, it contains one element. For trains consisting of multiple wings or

trains that switch locomotives along the way, it contains one element for each

trains that switch locomotives along the way, it contains one element for each

wing or other kind of wagon group.

wing or other kind of carriage group.

Each origin is a hash ref containing its B<name> and the corresponding

Each origin is a hash ref containing its B<name> and the corresponding

platform I<sections> (at the moment, this is a list of section identifiers).

platform I<sections> (at the moment, this is a list of section identifiers).

entries: B<ds100> (DS100 / Ril100 identifier), B<eva> (EVA ID, related to but

entries: B<ds100> (DS100 / Ril100 identifier), B<eva> (EVA ID, related to but

not necessarily identical with UIC station ID), and B<name> (station name).

not necessarily identical with UIC station ID), and B<name> (station name).

=item $wr->wagongroup_description

Returns two strings describing the rolling stock used for this train based on

model and locomotive (if present). The first one tries to be conscise (e.g.

"ICE 4"). The second is more detailed, e.g. "ICE 4 Hochgeschwindigkeitszug",

"IC 2 Twindexx mit elektrischer Lokomotive", or "Diesel-Triebzug".

=item $wr->wagongroup_model

Returns a string describing the rolling stock used for this train, e.g. "ICE 4"

or "IC2 KISS".

=item $wr->train_numbers

=item $wr->train_numbers

Returns the list of train numbers for this departure. In most cases, this is

Returns the list of train numbers for this departure. In most cases, this is

Returns a string describing the train type, e.g. "ICE" or "IC".

Returns a string describing the train type, e.g. "ICE" or "IC".

=item $wr->wagongroup_subtype

=item $wr->carriages

Returns a string describing the rolling stock model used for this train, e.g.

"412" (model 412 aka ICE 4) or "411.S2" (model 411 aka ICE T, series 2).

=item $wr->wagons

Describes the individual wagons the train consists of. Returns a list of

Describes the individual carriages the train consists of. Returns a list of

L<Travel::Status::DE::DBWagenreihung::Wagon> objects.

L<Travel::Status::DE::DBWagenreihung::Carriage> objects.

=back

=back