summaryrefslogtreecommitdiff
path: root/lib/Travel/Routing/DE/VRR/Route/Part.pm
blob: ee01bafa9036cc260383c313acfc5c6d93c3cebe (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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
package Travel::Routing::DE::VRR::Route::Part;

use strict;
use warnings;
use 5.010;

use parent 'Class::Accessor';

our $VERSION = '1.06';

Travel::Routing::DE::VRR::Route::Part->mk_ro_accessors(
	qw(arrival_stop arrival_time departure_stop departure_time train_line
	  train_destination)
);

sub new {
	my ( $obj, %conf ) = @_;

	my $ref = \%conf;

	return bless( $ref, $obj );
}

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

	return @{ $self->{extra} // [] };
}

1;

__END__

=head1 NAME

Travel::Routing::DE::VRR::Route::Part - Describes one connection between two
points, without interchanges

=head1 SYNOPSIS

	for my $part ( $route->parts ) {

		if ( $part->extra ) {
			say join( "\n", $part->extra );
		}

		printf(
			"%s at %s -> %s at %s, via %s to %s",
			$part->departure_time, $part->departure_stop,
			$part->arrival_time,   $part->arrival_stop,
			$part->train_line,     $part->train_destination,
		);
	}

=head1 VERSION

version 1.06

=head1 DESCRIPTION

B<Travel::Routing::DE::VRR::Route::Part> holds one specific connection (without
interchanges) between two points.  It specifies the start/stop point and time,
the train line and its destination, and optional additional data.

It is usually obtained by a call to Travel::Routing::DE::VRR::Route(3pm)'s
B<parts> method.

=head1 METHODS

=over

=item $part = Travel::Routing::DE::VRR::Route::Part->new(I<%data>)

Creates a new Travel::Routing::DE::VRR::Route::Part object. I<data> consists of:

=over

=item B<arrival_time> => I<HH>:I<MM>

Arrival time

=item B<arrival_stop> => I<name>

Arrival stop (city plus station / address)

=item B<departure_time> => I<HH:MM>

Departure time

=item B<departure_stop> => I<name>

Departure stop (city plus station / address)

=item B<train_destination> => I<name>

Destination of the train connecting the stops

=item B<train_line> => I<name>

The train's line name.

=item B<extra> => B<[> [ I<line1>, [ I<line2> [ I<...> ] ] ] B<]>

Additional information about this connection.  Array-ref of newline-terminated
strings.

=back

=item $part->get(I<name>)

Returns the value of I<name> (B<arrival_time>, B<arrival_stop> etc., see
B<new>).

Each of these I<names> also has an accessor. So C<< $part->departure_time() >>
is the same as C<< $part->get('departure_time') >>.

=item $part->extra()

Returns a list of additional information about this route part, if provided.
Returns an empty list otherwise.

=back

=head1 DIAGNOSTICS

None.

=head1 DEPENDENCIES

=over

=item * Class::Accessor(3pm)

=back

=head1 BUGS AND LIMITATIONS

None known.

=head1 SEE ALSO

Travel::Routing::DE::VRR(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.