Commit a32aaf53 authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

Update ::Result documentation

parent eff310b0
Loading
Loading
Loading
Loading
+50 −19
Original line number Diff line number Diff line
@@ -53,11 +53,31 @@ line number and destination.

=head2 ACCESSORS

"Actual" in the description means that the delay (if available) is already
included in the calculation, "Scheduled" means it isn't.

=over

=item $departure->countdown

Actual time in minutes from now until the tram/bus/train will depart.

If delay information is available, it is already included.

=item $departure->date

Actual departure date (DD.MM.YYYY).

=item $departure->delay

Expected delay from scheduled departure time in minutes.

Note that this is only available for DB trains, in other cases it will always
return 0.

=item $departure->destination

The tram/bus/train destination.
Destination name.

=item $departure->info

@@ -69,40 +89,51 @@ news related to the line's schedule.

The name/number of the line.

=item $departure->platform
=item $departure->lineref

The departure platform.  Note that this is prefixed by either "Bstg." (for
tram/bus departures) or "Gleis" (for trains).
Travel::Status::DE::VRR::Line(3pm) object describing the departing line in
detail.

=item $departure->time
=item $departure->platform

The departure time as string in "HH:MM" format.
Departure platform number.

=back
=item $departure->platform_db

=head2 INTERNAL
true if the platform number is operated by DB ("Gleis x"), false ("Bstg. x")
otherwise.

=over
Unfortunately, there is no distinction between tram and bus platforms yet,
which also may have the same numbers.

=item $departure = Travel::Status::DE::VRR::Result->new(I<%data>)
=item $departure->sched_date

Returns a new Travel::Status::DE::VRR::Result object.  You should not need to
call this.
Scheduled departure date (DD.MM.YYYY).

Required I<data>:
=item $departure->sched_time

=over
Scheduled departure time (HH:MM).

=item B<destination> => I<string>
=item $departure->time

=item B<line> => I<string>
Actual departure time (HH:MM).

=item B<platform> => I<string>
=item $departure->type

=item B<time> => I<string>
Type of the departing train, values observed so far are "StraE<szlig>enbahn",
"Bus", "NE", "S-Bahn" and "U-Bahn".

=back

=head2 INTERNAL

=over

=item $departure = Travel::Status::DE::VRR::Result->new(I<%data>)

Returns a new Travel::Status::DE::VRR::Result object.  You should not need to
call this.

=back

=head1 DIAGNOSTICS
@@ -119,7 +150,7 @@ None.

=head1 BUGS AND LIMITATIONS

Unknown.
Not all possible B<type> values are documented yet.

=head1 SEE ALSO