/ 
Map-Tube-Samara-0.07
River stage one • 1 direct dependent • 2 total dependents
/ Map::Tube::Samara

NAME

Map::Tube::Samara - Interface to the Samara Metro Map.

SYNOPSIS

use Map::Tube::Samara;
my $obj = Map::Tube::Samara->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 Samara Map, click here.

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 Samara metro.
Returns string with XML.

EXAMPLE1

# Pragmas.
use strict;
use warnings;

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

# Object.
my $obj = Map::Tube::Samara->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::Samara;

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

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

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

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

EXAMPLE3

# Pragmas.
use strict;
use warnings;

# Modules.
use Map::Tube::GraphViz;
use Map::Tube::GraphViz::Utils qw(node_color_without_label);
use Map::Tube::Samara;

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

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

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

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

# Output like:
# -rw-r--r-- 1 skim skim 28389 Jan  8 21:11 Samara.png
Самарский метрополитен

EXAMPLE4

# Pragmas.
use strict;
use warnings;

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

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

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

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

# Output:
# Первая линия

EXAMPLE5

# Pragmas.
use strict;
use warnings;

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

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

# Object.
my $obj = Map::Tube::Samara->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.
# Российская
# Московская
# Гагаринская
# Спортивная
# Советская
# Победа
# Безымянка
# Кировская
# Юнгородок

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-Samara

AUTHOR

Michal Josef Špaček mailto:skim@cpan.org

http://skim.cz

LICENSE AND COPYRIGHT

© 2014-2017 Michal Josef Špaček
Artistic License
BSD 2-Clause License

VERSION

0.07