NAME
    Map::Tube::SaintPetersburg - Interface to the Saint Petersburg Metro
    Map.

SYNOPSIS
     use Map::Tube::SaintPetersburg;

     my $obj = Map::Tube::SaintPetersburg->new;
     my $routes_ar = $obj->get_all_routes($from, $to);
     my $line = $obj->get_line_by_id($line_id);
     my $line = $obj->get_line_by_name($line_name);
     my $lines_ar = $obj->get_lines;
     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 $stations_ar = $obj->get_stations($line);
     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 Saint Petersburg Map, click here
    <https://en.wikipedia.org/wiki/Saint_Petersburg_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_line_by_id($line_id)"
             Get line object defined by id.
             Returns Map::Tube::Line object.

    "get_line_by_name($line_name)"
             Get line object defined by name.
             Returns Map::Tube::Line object.

    "get_lines()"
             Get lines in metro map.
             Returns reference to unsorted array with Map::Tube::Line 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.

    "get_stations($line)"
             Get list of stations for concrete metro line.
             Returns reference to array with Map::Tube::Node objects.

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

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

EXAMPLE1
     use strict;
     use warnings;

     use Encode qw(decode_utf8 encode_utf8);
     use Map::Tube::SaintPetersburg;

     # Object.
     my $obj = Map::Tube::SaintPetersburg->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
     use strict;
     use warnings;

     use Map::Tube::SaintPetersburg;

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

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

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

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

EXAMPLE3
     use strict;
     use warnings;

     use Map::Tube::GraphViz;
     use Map::Tube::GraphViz::Utils qw(node_color_without_label);
     use Map::Tube::SaintPetersburg;

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

     # GraphViz object.
     my $g = Map::Tube::GraphViz->new(
             'callback_node' => \&node_color_without_label,
             'tube' => $obj,
     );

     # Get graph to file.
     $g->graph('SaintPetersburg.png');

     # Print file.
     system "ls -l SaintPetersburg.png";

     # Output like:
     # -rw-r--r-- 1 skim skim 200586 23. led 11.50 SaintPetersburg.png

EXAMPLE4
     use strict;
     use warnings;

     use Encode qw(encode_utf8);
     use Map::Tube::SaintPetersburg;

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

     # Get lines.
     my $lines_ar = $obj->get_lines;

     # Print out.
     map { print encode_utf8($_->name)."\n"; } sort @{$lines_ar};

     # Output:
     # �惧解�郋赲�郕郋-�瑹氵教憾�迣�郕訄�� 郅邽郇邽��
     # �婧憾�郕郋赲�郕郋-�氱萃��郋迣�訄迡�郕訄�� 郅邽郇邽��
     # �嘞菩紼�郕郋-�𠸝參�邽郅迮郋���郋赲�郕訄�� 郅邽郇邽��
     # �𠇲�訄赲郋訇迮�迮迠郇訄�� 郅邽郇邽��
     # 苳��郇郱迮郇�郕郋-�𠇲�邽邾郋��郕訄�� 郅邽郇邽��

EXAMPLE5
     use strict;
     use warnings;

     use Encode qw(decode_utf8 encode_utf8);
     use Map::Tube::SaintPetersburg;

     # Arguments.
     if (@ARGV < 1) {
             print STDERR "Usage: $0 line\n";
             exit 1;
     }
     my $line = decode_utf8($ARGV[0]);

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

     # Get stations for line.
     my $stations_ar = $obj->get_stations($line);

     # Print out.
     map { print encode_utf8($_->name)."\n"; } @{$stations_ar};

     # Output:
     # Usage: __PROG__ line

     # Output with 'foo' argument.
     # Map::Tube::get_stations(): ERROR: Invalid Line Name [foo]. (status: 105) file __PROG__ on line __LINE__

     # Output with '�𠇲�訄赲郋訇迮�迮迠郇訄�� 郅邽郇邽��' argument.
     # 苤郈訄��郕訄��
     # �秴憾��郋迮赲�郕訄��
     # �𠝹覜創憶紼�郕邽邿 郈�郋�郈迮郕�
     # �氱鉼憾亀匾棋� �𡤕鉼菩碧�訄郇迡�訄 �嘞菩紼�郕郋迣郋-2
     # �嘞憶紹憾箮萃�郕訄��郕訄��
     # �𠝹匾棣憶剽�郕訄��
     # �𠇲�郋�郈迮郕� �煷憶銑𧄍�菩紹覜碟憶�
     # 苺郅邽�訄 �䅮氵教菩請碟�

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

SEE ALSO
    Map::Tube
        Core library as Role (Moo) to process map data.

    Task::Map::Tube
        Install the Map::Tube modules.

    Task::Map::Tube::Metro
        Install the Map::Tube concrete metro modules.

REPOSITORY
    <https://github.com/michal-josef-spacek/Map-Tube-SaintPetersburg>

AUTHOR
    Michal Josef �麖a�嶤k <mailto:skim@cpan.org>

    <http://skim.cz>

LICENSE AND COPYRIGHT
    穢 2014-2025 Michal Josef �麖a�嶤k

    Artistic License

    BSD 2-Clause License

VERSION
    0.08