summaryrefslogtreecommitdiff
path: root/lib/Travel/Routing/DE/VRR/Route.pm
blob: e460f7d28920e37c5f05cdb9e31b5bea357e7f3a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
package Travel::Routing::DE::VRR::Route;

use strict;
use warnings;
use 5.010;

use parent 'Class::Accessor';

use Travel::Routing::DE::VRR::Route::Part;

our $VERSION = '2.01';

Travel::Routing::DE::VRR::Route->mk_ro_accessors(
	qw(duration ticket_text ticket_type fare_adult fare_child vehicle_time));

sub new {
	my ( $obj, $info, @parts ) = @_;

	my $ref = $info;

	for my $part (@parts) {
		push(
			@{ $ref->{parts} },
			Travel::Routing::DE::VRR::Route::Part->new( %{$part} )
		);
	}

	return bless( $ref, $obj );
}

sub parts {
	my ($self) = @_;

	return @{ $self->{parts} };
}

1;

__END__

=head1 NAME

Travel::Routing::DE::VRR::Route - Single route (connection) between two points

=head1 SYNOPSIS

	for my $route ( $efa->routes ) {
		for my $part ( $route->parts ) {
			# $part is a Travel::Routing::DE::VRR::Route::Part object
		}
	}

=head1 VERSION

version 2.01

=head1 DESCRIPTION

Travel::Routing::DE::VRR::Route describes a single method of getting from one
point to another.  It holds a bunch of Travel::Routing::DE::VRR::Route::Part(3pm)
objects describing the parts of the route in detail.  Each part depends on the
previous one.

You usually want to acces it via C<< $efa->routes >>.

=head1 METHODS

=head2 ACCESSORS

=over

=item $route->duration

route duration as string in HH:MM format

=item $route->parts

Returns a list of Travel::Routing::DE::VRR::Route::Part(3pm) elements describing
the actual route

=item $route->ticket_type

Type of the required ticket for this route, if available (empty string otherwise)

=item $route->fare_adult

ticket price for an adult in EUR

=item $route->fare_child

ticket price for a child in EUR

=item $route->vehicle_time

on-vehicle time (excluding waiting time) of the route in minutes

=back

=head1 DIAGNOSTICS

None.

=head1 DEPENDENCIES

None.

=head1 BUGS AND LIMITATIONS

None known.

=head1 SEE ALSO

Travel::Routing::DE::VRR(3pm), Travel::Routing::DE::VRR::Route::Part(3pm).

=head1 AUTHOR

Copyright (C) 2011 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>

=head1 LICENSE

  0. You just DO WHAT THE FUCK YOU WANT TO.