/ 
WWW-PIDS-0.01
River stage zero No dependents
/ WWW::PIDS::PredictedTime

NAME

WWW::PIDS::PredictedTime - Utility class for representing predicted arrival times for the PIDS tramTRACKER service.

DESCRIPTION

WWW::PIDS::PredictedTime is a utility class for representing predicted arrival times for the PIDS tramTRACKER service.

METHODS

AirConditioned

Returns a boolean value ('true' or 'false') indicating if the service is air-conditioned.

Destination

Returns the end of line destination for the service as a human-readable location. e.g. 'East Coburg' or 'Moreland'.

Deviation

Returns a value indicating the time deviation of the predicated arrival time from the scheduled arrival time.

DisplayAC

Returns a boolean value ('true' or 'false') indicating if the service displays air-conditioned status.

HasDisruption

Returns a boolean value ('true' or 'false') indicating if the service has a disruption.

HasSpecialEvent

Returns a boolean value ('true' or 'false') indicating if the service is scheduled for a special event.

HeadboardRouteNo

Returns the headboard route number.

InternalRouteNo

Returns the internal route number.

IsLowFloorTram

Returns a boolean value ('true' or 'false') indicating if the service is a low- floor service.

IsTTAvailable

Returns a boolean value ('true' or 'false') indicating if the service has time- table information available.

PredictedArrivalDateTime

Returns the predicted arrival timestamp of the service in the format:

YYYY-MM-DDThh:mm:ss+TZhh:TZmm

PredictionType

returns the predicted arrival time type.

RequestDateTime

Returns the client-provided timestamp for the request (i.e. the value of the clientRequestDateTime parameter in the invocating method) using the format:

YYYY-MM-DDThh:mm:ss+TZhh:TZmm

RouteNo

Returns the route number of the service.

SpecialEventMessage

Returns the special event message.

TripID

Returns the tramTRACKER trip ID.

VehicleNo

Returns the service vehicle number.

AUTHOR

Luke Poskitt, <ltp at cpan.org>

BUGS

Please report any bugs or feature requests to bug-www-pids at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-PIDS. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WWW::PIDS

You can also look for information at:

SEE ALSO

WWW::PIDS WWW::PIDS::ScheduledTime

LICENSE AND COPYRIGHT

Copyright 2015 Luke Poskitt.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.