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 207926 Feb 18 07:13 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/tupinek/Map-Tube-SaintPetersburg>

AUTHOR
    Michal Josef ﾅ�paﾄ稿k <mailto:skim@cpan.org>

    <http://skim.cz>

LICENSE AND COPYRIGHT
    ﾂｩ 2014-2025 Michal Josef ﾅ�paﾄ稿k

    Artistic License

    BSD 2-Clause License

VERSION
    0.07