summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2024-04-28 20:14:55 +0200
committerBirte Kristina Friesel <derf@finalrewind.org>2024-04-28 20:14:55 +0200
commit8cc41bfc9a5c02e93cd441ab31e3fa37e4c715ef (patch)
treee72798f12f9fdb4843f0668d62d9de64e9e05d16 /lib
parentb93ac311ce6e979ccab13a35448b1c5d6e442c86 (diff)
DBWagenreihung(3pm): add ->groups
Diffstat (limited to 'lib')
-rw-r--r--lib/Travel/Status/DE/DBWagenreihung.pm37
1 files changed, 22 insertions, 15 deletions
diff --git a/lib/Travel/Status/DE/DBWagenreihung.pm b/lib/Travel/Status/DE/DBWagenreihung.pm
index 77813d5..e40c194 100644
--- a/lib/Travel/Status/DE/DBWagenreihung.pm
+++ b/lib/Travel/Status/DE/DBWagenreihung.pm
@@ -825,12 +825,22 @@ Train number. Do not include the train type: Use "8" for "EC 8" or
=back
-=item $wr->destinations
+=item $wr->errstr
-Returns a list describing the unique destinations of this train's carriage
-groups. Each origin is a hashref that contains its B<name>, a B<groups>
-arrayref to the corresponding Travel::Status::DE::DBWagenreihung::Group(3pm)
-objects, and a B<sections> arrayref to section identifiers (subject to change).
+In case of a fatal HTTP or backend error, returns a string describing it.
+Returns undef otherwise.
+
+=item $wr->groups
+
+Returns a list of Travel::Status::DE::DBWagenreihung::Group(3pm) objects
+which describe the groups making up the carriage formation. Typically, each
+group has a distinct origin, destination, or train number. Each group contains
+a set of carriages.
+
+=item $wr->carriages
+
+Describes the individual carriages the train consists of. Returns a list of
+L<Travel::Status::DE::DBWagenreihung::Wagon> objects.
=item $wr->direction
@@ -838,11 +848,6 @@ Gives the train's direction of travel. Returns 0 if the train will depart
towards position 0 and 100 if the train will depart towards the other platform
end (mnemonic: towards the 100% position).
-=item $wr->errstr
-
-In case of a fatal HTTP or backend error, returns a string describing it.
-Returns undef otherwise.
-
=item $wr->origins
Returns a list describing the unique origins of this train's carriage groups.
@@ -850,6 +855,13 @@ Each origin is a hashref that contains its B<name>, a B<groups> arrayref to the
corresponding Travel::Status::DE::DBWagenreihung::Group(3pm) objects, and
a B<sections> arrayref to section identifiers (subject to change).
+=item $wr->destinations
+
+Returns a list describing the unique destinations of this train's carriage
+groups. Each origin is a hashref that contains its B<name>, a B<groups>
+arrayref to the corresponding Travel::Status::DE::DBWagenreihung::Group(3pm)
+objects, and a B<sections> arrayref to section identifiers (subject to change).
+
=item $wr->platform
Returns the platform name.
@@ -883,11 +895,6 @@ arrayref to section identifiers (subject to change).
Returns a string describing the train type, e.g. "ICE" or "IC".
-=item $wr->carriages
-
-Describes the individual carriages the train consists of. Returns a list of
-L<Travel::Status::DE::DBWagenreihung::Carriage> objects.
-
=back
=head1 DEPENDENCIES