The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

# -*- perl -*-
#
# Author: Gisbert W. Selke, TapirSoft Selke & Selke GbR.
#
# Copyright (C) 2025 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: gws@cpan.org
#
use 5.12.0;
use version 0.77 ( );
use strict;
our $VERSION = version->declare('v0.1.0');
=encoding utf8
=head1 NAME
Map::Tube::Stuttgart - Interface to the Stuttgart tube map
=cut
use File::Share ':all';
use Moo;
has xml => ( is => 'ro', default => sub { return dist_file('Map-Tube-Stuttgart', 'stuttgart-map.xml') } );
with 'Map::Tube';
=head1 SYNOPSIS
use Map::Tube::Stuttgart;
my $tube = Map::Tube::Stuttgart->new( );
my $route = $tube->get_shortest_route('Wilhelma', 'Bopser')->preferred( );
print "Route: $route\n";
=head1 DESCRIPTION
This module allows to find the shortest route between any two given tube
stations in Stuttgart. All interesting methods are provided by the role
L<Map::Tube>.
=head1 METHODS
=head2 CONSTRUCTOR
use Map::Tube::Stuttgart;
my $tube = Map::Tube::Stuttgart->new( );
The only argument, C<xml>, 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<stuttgart-map.xml>
that is a part of this distribution. For further information see L<Map::Tube>.
=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 taken from L<www.vvs.de>.
The module itself is free software; you may redistribute and/or modify it under
the same terms as Perl itself.
=head1 SEE ALSO
L<Map::Tube>, L<Map::Tube::GraphViz>.
=cut
1;