The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
WWW-PTV-0.07
River stage zero No dependents
++
/ WWW::PTV::Stop

NAME

WWW::PTV::Stop - Class for operations with Public Transport Victoria (PTV) stops

SYNOPSIS

        # Get a WWW::PTV::Stop object representative of stop ID 30801
        my $stop = $ptv->get_stop_by_id(30801);

        # Print the stop address, type and map reference.
        print "Stop: " . $stop->address . " - Type: " .
        $stop->type . " - Map: " . $stop->map_ref . "\n";

METHODS

address

Returns the stop address as a freeform text value.

bicycle_cage

Returns a value indicating if the stop has bicycle cage facilities - this typically has a value of either 'Yes' or 'No'.

bicycle_lockers

Returns a value indicating if the stop has bicycle locker facilities - this typically has a value of either 'Yes' or 'No'.

bicycle_racks

Returns a value indicating if the stop has bicycle rack facilities - this typically has a value of either 'Yes' or 'No'.

car_parking

Returns a value indicating if the stop has car parking rack facilities - this typically has a value of either 'Yes' or 'No'.

escalator

Returns a value indicating if the stop has escalator facilities - this typically has a value of either 'Yes' or 'No'.

hearing_loop

Returns a value indicating if the stop has hearing loop facilities - this typically has a value of either 'Yes' or 'No'.

id

Returns the numerical ID of the stop.

latitude

Returns the latitude of the stop as a floating point value.

lift

Returns a value indicating if the stop has lift facilities - this typically has a value of either 'Yes' or 'No'.

lighting

Returns a value indicating if the stop has lighting facilities - this typically has a value of either 'Yes' or 'No'.

lines

Returns a value indicating if the stop has lines - this typically has a value of either 'Yes' or 'No'.

locality

Returns the stop locality typically in the format of a locality or suburb name, and postpode. e.g. "Belmont 3216".

lockers

Returns a value indicating if the stop has lines - this typically has a value of either 'Yes' or 'No'.

longitude

Returns the latitude of the stop as a floating point value.

map_ref

Returns a Google Maps URL for the stop location.

municipiality

Returns the municipiality of which the stop is located in as free-form text. e.g. "Greater Geelong".

municipiality_id

Returns the numerical identifier of the stop municipiality.

myki_checks

Returns a value indicating if the stop has Myki check facilities - this typically has a value of either 'Yes' or 'No'.

myki_machines

Returns a value indicating if the stop has Myki machine facilities - this typically has a value of either 'Yes' or 'No'.

phone_feedback

Returns a value indicating if the stop has phone feedback facilities - this typically has a value of either 'Yes' or 'No'.

phone_station

Returns the stop phone number (if any).

postcode

Returns the postcode in which the stop is located.

public_phone

Returns a value indicating if the stop has public phone facilities - this typically has a value of either 'Yes' or 'No'.

public_toilet

Returns a value indicating if the stop has public toilet facilities - this typically has a value of either 'Yes' or 'No'.

get_routes

Returns the routes servicing this stop as an array of hashes, where each hash contains three key/value pairs;

  • id - the route numerical identifier.

  • name - a descriptive name of the route.

  • type - the type of transport (e.g. bus, train).

get_route_ids

Returns an array containing the route IDs that service this stop.

Please note that these route IDs are the PTV defined route IDs and not the collaquial IDs that may be assigned to the service. e.g. "The number 19 bus".

get_route_names

Returns an array containing the route names that service this stop.

These names often contain teh collaquial route ID of the service in a free text format. e.g. "235 - City - Fishermans Bend via Lorimer Street".

seating

Returns a value indicating if the stop has seating facilities - this typically has a value of either 'Yes' or 'No'.

staff_hours

Returns the staffing hours for the selected stop - note that this is free-form text that may make use of symbolic or shorthand notation - e.g. 'N'.

stairs

Returns a value indicating if the stop has stairs - this typically has a value of either 'Yes' or 'No'.

street

Returns the street on which the stop is located.

tactile_paths

Returns a value indicating if the stop has tactile paths - this typically has a value of either 'Yes' or 'No'.

taxi_rank

Returns a value indicating if the stop has taxi rank facilities - this typically has a value of either 'Yes' or 'No'.

transport_type

Returns the stop transport type - e.g. "bus", "train", etc.

vline_bookings

Returns a value indicating if the stop has VLine booking facilities - this typically has a value of either 'Yes' or 'No'.

waiting_area_indoor

Returns a value indicating if the stop has an indoor waiting area - this typically has a value of either 'Yes' or 'No'.

waiting_area_sheltered

Returns a value indicating if the stop has sheltered indoor waiting area - this typically has a value of either 'Yes' or 'No'.

wheelchair_accessible

Returns a value indicating if the stop has wheelchair facilities - this typically has a value of either 'Yes' or 'No'.

zone

Returns the stop zone (per the PTV zoning system) as a comma-seperated zone name and zone numerical identifier - e.g. "Regional, 4".

SEE ALSO

WWW::PTV, WWW::PTV::Area, WWW::PTV::Route, WWW::PTV::TimeTable, WWW::PTV::TimeTable::Schedule.

AUTHOR

Luke Poskitt, <ltp at cpan.org>

BUGS

Please report any bugs or feature requests to bug-www-ptv-stop at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-PTV-Stop. 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::PTV::Stop

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2014 Luke Poskitt.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.