| 1 | # -*- perl -*- | ||
| 2 | # | ||
| 3 | # Author: Gisbert W. Selke, TapirSoft Selke & Selke GbR. | ||
| 4 | # | ||
| 5 | # Copyright (C) 2015, 2025 Gisbert W. Selke. All rights reserved. | ||
| 6 | # This package is free software; you can redistribute it and/or | ||
| 7 | # modify it under the same terms as Perl itself. | ||
| 8 | # | ||
| 9 | # Mail: gws@cpan.org | ||
| 10 | # | ||
| 11 | package Map::Tube::Hamburg; | ||
| 12 | 1 | ▶ | use 5.14.0; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 13 | 1 | ▶ | use version 0.77 ( ); |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 14 | 1 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 15 | 1 | ▶ | use warnings; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 16 | |||
| 17 | our $VERSION = version->declare('v0.1.4'); | ||
| 18 | |||
| 19 | =encoding utf8 | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Map::Tube::Hamburg - Interface to the Hamburg U- and S-Bahn maps including AKN | ||
| 24 | |||
| 25 | =cut | ||
| 26 | |||
| 27 | 1 | ▶ | use File::Share ':all'; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 28 | 1 | ▶ | use Moo; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 29 | 1 | ▶ | use namespace::clean; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 30 | |||
| 31 | has xml => ( is => 'ro', default => sub { return dist_file('Map-Tube-Hamburg', 'hamburg-map.xml') } ); | ||
| 32 | |||
| 33 | with 'Map::Tube'; | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | use Map::Tube::Hamburg; | ||
| 38 | my $tube = Map::Tube::Hamburg->new(); | ||
| 39 | |||
| 40 | my $route = $tube->get_shortest_route('Hagendeel', 'Reeperbahn'); | ||
| 41 | |||
| 42 | print "Route: $route\n"; | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | This module allows to find the shortest route between any two given tube | ||
| 47 | stations in Hamburg. In fact, underground, S-Bahn, and AKN (Altona-Kaltenkirchen-Neumünster) lines | ||
| 48 | are covered for the wider Hamburg area. | ||
| 49 | All interesting methods are provided by the role L<Map::Tube>. | ||
| 50 | |||
| 51 | =head1 METHODS | ||
| 52 | |||
| 53 | =head2 CONSTRUCTOR | ||
| 54 | |||
| 55 | use Map::Tube::Hamburg; | ||
| 56 | my $tube = Map::Tube::Hamburg->new(); | ||
| 57 | |||
| 58 | The only argument, C<xml>, is optional; if specified, it should be a code ref | ||
| 59 | to a function that returns either the path the XML map file, or a string | ||
| 60 | containing this XML content. The default is the path to F<hamburg-map.xml> | ||
| 61 | that is a part of this distribution. For further information see L<Map::Tube>. | ||
| 62 | |||
| 63 | =head2 xml() | ||
| 64 | |||
| 65 | This read-only accessor returns whatever was specified as the XML source at | ||
| 66 | construction. | ||
| 67 | |||
| 68 | =head1 ERRORS | ||
| 69 | |||
| 70 | If something goes wrong, maybe because the map information file was corrupted, | ||
| 71 | the constructor will die. | ||
| 72 | |||
| 73 | =head1 BUGS | ||
| 74 | |||
| 75 | Please report any bugs or feature requests through the web interface at | ||
| 76 | L<https://github.com/gwselke/Map-Tube-Hamburg/issues>. I will be | ||
| 77 | notified and then you'll automatically be notified of progress on your | ||
| 78 | bug when (and if) I make changes. | ||
| 79 | |||
| 80 | =head1 AUTHOR | ||
| 81 | |||
| 82 | Gisbert W. Selke, TapirSoft Selke & Selke GbR <gws@cpan.org> | ||
| 83 | |||
| 84 | =head1 COPYRIGHT AND LICENCE | ||
| 85 | |||
| 86 | The data for the XML file were mainly taken from the appropriate | ||
| 87 | OpenStreetMap maps. They are CC BY-SA 2.0. The module itself is free | ||
| 88 | software; you may redistribute and/or modify it under the same terms as | ||
| 89 | Perl itself. | ||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | L<Map::Tube>, L<Map::Tube::GraphViz>. | ||
| 94 | |||
| 95 | =cut | ||
| 96 | |||
| 97 | 1; | ||