gitpan / map-tube-minsk Goto Github PK

NAME
    Map::Tube::Minsk - Interface to the Minsk metro.

SYNOPSIS
     use Map::Tube::Minsk;
     my $obj = Map::Tube::Minsk->new;
     my $routes_ar = $obj->get_all_routes($from, $to);
     my $station = $obj->get_node_by_id($station_id);
     my $station = $obj->get_node_by_name($station_name);
     my $route = $obj->get_shortest_route($from, $to);
     my $metro_name = $obj->name;
     my $xml_file = $obj->xml;

DESCRIPTION
    It currently provides functionality to find the shortest route between
    the two given nodes.

    For more information about Minsk imetro map, click here
    <https://en.wikipedia.org/wiki/Minsk_Metro>.

METHODS
    "new()"
             Constructor.

    "get_all_routes($from, $to)" [EXPERIMENTAL]
             Get all routes from station to station.
             Returns reference to array with Map::Tube::Route objects.

    "get_node_by_id($station_id)"
             Get station node by id.
             Returns Map::Tube::Node object.

    "get_node_by_name($station_name)"
             Get station node by name.
             Returns Map::Tube::Node object.

    "get_shortest_route($from, $to)"
             Get shortest route between $from and $to node names. Node names in $from and $to are case insensitive.
             Returns Map::Tube::Route object.

    "name()"
             Get metro name.
             Returns string with metro name.

    "xml()"
             Get XML specification of Minsk metro.
             Returns string with XML.

EXAMPLE1
     # Pragmas.
     use strict;
     use warnings;

     # Modules.
     use Encode qw(decode_utf8 encode_utf8);
     use Map::Tube::Minsk;

     # Object.
     my $obj = Map::Tube::Minsk->new;

     # Get route.
     my $route = $obj->get_shortest_route(decode_utf8('Уручча'), decode_utf8('Усход'));

     # Print out type.
     print "Route: ".encode_utf8($route)."\n";

     # Output:
     # Route: Уручча (Маскоўская_лінія), Барысаўскі тракт (Маскоўская_лінія), Усход (Маскоўская_лінія)

EXAMPLE2
     # Pragmas.
     use strict;
     use warnings;

     # Modules.
     use Map::Tube::Minsk;

     # Object.
     my $obj = Map::Tube::Minsk->new;

     # Get XML file.
     my $xml_file = $obj->xml;

     # Print out XML file.
     print "XML file: $xml_file\n";

     # Output like:
     # XML file: .*/minsk-map.xml

DEPENDENCIES
    File::Share, Map::Tube, Moo, namespace::clean.

SEE ALSO
    Map::Tube, Map::Tube::Barcelona, Map::Tube::Berlin, Map::Tube::Delhi,
    Map::Tube::Kiew, Map::Tube::London, Map::Tube::Moscow, Map::Tube::NYC,
    Map::Tube::Prague, Map::Tube::Sofia, Map::Tube::Tokyo,
    Map::Tube::Warsaw.

REPOSITORY
    <https://github.com/tupinek/Map-Tube-Minsk>

AUTHOR
    Michal Špaček <mailto:[email protected]>

    <http://skim.cz>

LICENSE AND COPYRIGHT
     © 2014 Michal Špaček
     Artistic License
     BSD 2-Clause License

VERSION
    0.02