File Coverage

blib/lib/Map/Tube/KoelnBonn.pm

Criterion	Covered	Total	%
statement	15	15	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod			n/a
total	20	20	100.0

# -*- perl -*-
#
# Author: Gisbert W. Selke, TapirSoft Selke & Selke GbR.
#
# Copyright (C) 2015 Gisbert W. Selke. All rights reserved.
# This package is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
#
# Mail: [e-mail]
#
package Map::Tube::KoelnBonn;
use strict;
use warnings;

our $VERSION = '0.09';

=encoding utf8

=head1 NAME

Map::Tube::KoelnBonn - Interface to the Koeln-Bonn U- and S-Bahn and tram maps

=cut

use File::Share ':all';
use Moo;
use namespace::clean;

has xml => ( is => 'ro', default => sub { return dist_file('Map-Tube-KoelnBonn', 'koelnbonn-map.xml') } );

with 'Map::Tube';

=head1 SYNOPSIS

    use Map::Tube::KoelnBonn;
    my $tube = Map::Tube::KoelnBonn->new();

    my $route = $tube->get_shortest_route('Wurzerstr.', 'Plittersdorf');

    print "Route: $route\n";

=head1 DESCRIPTION

This module allows to find the shortest route between any two given tube
stations in Köln and Bonn. In fact, underground, tramway, and S-Bahn lines
are covered for the wider Köln-Bonn area (VRS).
All interesting methods are provided by the role L.

=head1 METHODS

=head2 CONSTRUCTOR

    use Map::Tube::KoelnBonn;
    my $tube = Map::Tube::KoelnBonn->new();

The only argument, C, is optional; if specified, it should be a code ref
to a function that returns either the path the XML map file, or a string
containing this XML content. The default is the path to F
that is a part of this distribution. For further information see L.

=head2 xml()

This read-only accessor returns whatever was specified as the XML source at
construction.

=head1 ERRORS

If something goes wrong, maybe because the map information file was corrupted,
the constructor will die.

=head1 AUTHOR

Gisbert W. Selke, TapirSoft Selke & Selke GbR

=head1 COPYRIGHT AND LICENCE

The data for the XML file were mainly taken from the appropriate OpenStreetMap
maps. They are CC BY-SA 2.0, with some modifications made based on personal
knowledge, in particular in order to disambiguate station names. The module
itself is free software; you may redistribute and/or modify it under the
same terms as Perl itself.

=head1 SEE ALSO

L, L.

=cut

1;