File Coverage

blib/lib/AI/Pathfinding/OptimizeMultiple/Scan.pm

Criterion	Covered	Total	%
statement	13	17	76.4
branch			n/a
condition			n/a
subroutine	5	7	71.4
pod	3	3	100.0
total	21	27	77.7

line	stmt	sub	pod	time	code
1					package AI::Pathfinding::OptimizeMultiple::Scan;
2					$AI::Pathfinding::OptimizeMultiple::Scan::VERSION = '0.0.16';
3	2	2		15	use strict;
	2			6
	2			63
4	2	2		11	use warnings;
	2			4
	2			63
5
6	2	2		35	use 5.012;
	2			8
7
8	2	2		17	use MooX qw/late/;
	2			5
	2			14
9
10					has cmd_line => ( isa => 'Str', is => 'ro', required => 1, );
11					has id => ( isa => 'Str', is => 'ro', required => 1, );
12					has used => ( isa => 'Bool', is => 'rw', default => sub { 0; } );
13
14					sub mark_as_used
15					{
16	8	8	1	14	my $self = shift;
17	8			143	$self->used(1);
18					}
19
20					sub is_used
21					{
22	0	0	1		my $self = shift;
23	0				return $self->used();
24					}
25
26					sub data_file_path
27					{
28	0	0	1		my $self = shift;
29
30	0				return "./data/" . $self->id() . ".data.bin";
31					}
32
33					1;
34
35					__END__
36
37					=pod
38
39					=encoding UTF-8
40
41					=head1 NAME
42
43					AI::Pathfinding::OptimizeMultiple::Scan
44
45					=head1 VERSION
46
47					version 0.0.16
48
49					=head1 SLOTS
50
51					=head2 $scan->cmd_line()
52
53					The command line string, which defines the scan's behaviour - required upon
54					initialization.
55
56					=head2 $scan->id()
57
58					The scan ID - a string.
59
60					=head2 $scan->used()
61
62					A boolean - whether the scan was used.
63
64					=head1 METHODS
65
66					=head2 $self->mark_as_used()
67
68					Mark the scan as used.
69
70					=head2 $self->is_used()
71
72					Returns whether the scan was used.
73
74					=head2 $scan->data_file_path()
75
76					Returns the path to the data file of the scan, where the numbers of iterations
77					per board are stored.
78
79					=for :stopwords cpan testmatrix url bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
80
81					=head1 SUPPORT
82
83					=head2 Websites
84
85					The following websites have more information about this module, and may be of help to you. As always,
86					in addition to those websites please use your favorite search engine to discover more resources.
87
88					=over 4
89
90					=item *
91
92					MetaCPAN
93
94					A modern, open-source CPAN search engine, useful to view POD in HTML format.
95
96					L<https://metacpan.org/release/AI-Pathfinding-OptimizeMultiple>
97
98					=item *
99
100					RT: CPAN's Bug Tracker
101
102					The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.
103
104					L<https://rt.cpan.org/Public/Dist/Display.html?Name=AI-Pathfinding-OptimizeMultiple>
105
106					=item *
107
108					CPANTS
109
110					The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
111
112					L<http://cpants.cpanauthors.org/dist/AI-Pathfinding-OptimizeMultiple>
113
114					=item *
115
116					CPAN Testers
117
118					The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.
119
120					L<http://www.cpantesters.org/distro/A/AI-Pathfinding-OptimizeMultiple>
121
122					=item *
123
124					CPAN Testers Matrix
125
126					The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
127
128					L<http://matrix.cpantesters.org/?dist=AI-Pathfinding-OptimizeMultiple>
129
130					=item *
131
132					CPAN Testers Dependencies
133
134					The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
135
136					L<http://deps.cpantesters.org/?module=AI::Pathfinding::OptimizeMultiple>
137
138					=back
139
140					=head2 Bugs / Feature Requests
141
142					Please report any bugs or feature requests by email to C<bug-ai-pathfinding-optimizemultiple at rt.cpan.org>, or through
143					the web interface at L<https://rt.cpan.org/Public/Bug/Report.html?Queue=AI-Pathfinding-OptimizeMultiple>. You will be automatically notified of any
144					progress on the request by the system.
145
146					=head2 Source Code
147
148					The code is open to the world, and available for you to hack on. Please feel free to browse it and play
149					with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull
150					from your repository :)
151
152					L<http://github.com/shlomif/fc-solve>
153
154					git clone ssh://git@github.com/shlomif/fc-solve.git
155
156					=head1 AUTHOR
157
158					Shlomi Fish <shlomif@cpan.org>
159
160					=head1 BUGS
161
162					Please report any bugs or feature requests on the bugtracker website
163					L<https://github.com/shlomif/ai-pathfinding-optimizemultiple/issues>
164
165					When submitting a bug or request, please include a test-file or a
166					patch to an existing test-file that illustrates the bug or desired
167					feature.
168
169					=head1 COPYRIGHT AND LICENSE
170
171					This software is Copyright (c) 2012 by Shlomi Fish.
172
173					This is free software, licensed under:
174
175					The MIT (X11) License
176
177					=cut