diff options
Diffstat (limited to 'lib/Travel/Status/DE/VRR/Line.pm')
| -rw-r--r-- | lib/Travel/Status/DE/VRR/Line.pm | 57 |
1 files changed, 26 insertions, 31 deletions
diff --git a/lib/Travel/Status/DE/VRR/Line.pm b/lib/Travel/Status/DE/VRR/Line.pm index 9abe473..64ad56b 100644 --- a/lib/Travel/Status/DE/VRR/Line.pm +++ b/lib/Travel/Status/DE/VRR/Line.pm @@ -43,7 +43,10 @@ version 0.02 =head1 DESCRIPTION -FIXME +Travel::Status::DE::VRR::Line describes a tram/bus/train line departing at the +stop requested by Travel::Status::DE::VRR. Note that it only covers one +direction, so in most cases, you get two Travel::Status::DE::VRR::Line objects +per actual line. =head1 METHODS @@ -51,53 +54,45 @@ FIXME =over -=item $departure->destination +=item $line->direction -The tram/bus/train destination. +Direction of the line. Name of either the destination stop or one on the way. -=item $departure->info +=item $line->name -Additional information related to the departure (string). If departures for -an address were requested, this is the stop name, otherwise it may be recent -news related to the line's schedule. +Name of the line, e.g. "U11", "SB15", "107". -=item $departure->line +=item $line->operator -The name/number of the line. +Operator of the line, as in the local transit company responsible for it. -=item $departure->platform +=item $line->route -The departure platform. Note that this is prefixed by either "Bstg." (for -tram/bus departures) or "Gleis" (for trains). +Partial route of the line (as string), usually start and destination with two +stops in between. -=item $departure->time +Note that start means the actual start of the line, the stop requested by +Travel::Status::DE::VRR::Line may not even be included in this listing. -The departure time as string in "HH:MM" format. +=item $line->type -=back - -=head2 INTERNAL +Type of the line. Observed values so far are "Bus", "NE", "StraE<szlig>enbahn", +"U-Bahn". -=over +=item $line->valid -=item $departure = Travel::Status::DE::VRR::Result->new(I<%data>) +When / how long above information is valid. -Returns a new Travel::Status::DE::VRR::Result object. You should not need to -call this. +=back -Required I<data>: +=head2 INTERNAL =over -=item B<destination> => I<string> - -=item B<line> => I<string> - -=item B<platform> => I<string> +=item $line = Travel::Status::DE::VRR::Line->new(I<%data>) -=item B<time> => I<string> - -=back +Returns a new Travel::Status::DE::VRR::Line object. You should not need to +call this. =back @@ -115,7 +110,7 @@ None. =head1 BUGS AND LIMITATIONS -Unknown. +The B<route> accessor returns a simple string, an array might be better suited. =head1 SEE ALSO |