File Coverage

blib/lib/Ekahau/Response/MapImage.pm
Criterion Covered Total %
statement 9 17 52.9
branch 0 2 0.0
condition n/a
subroutine 3 8 37.5
pod 4 5 80.0
total 16 32 50.0


line stmt bran cond sub pod time code
1             package Ekahau::Response::MapImage;
2 6     6   42 use base 'Ekahau::Response'; our $VERSION=Ekahau::Response::VERSION;
  6         16  
  6         13050  
3              
4             # Written by Scott Gifford
5             # Copyright (C) 2004 The Regents of the University of Michigan.
6             # See the file LICENSE included with the distribution for license
7             # information.
8              
9 6     6   57 use strict;
  6         15  
  6         263  
10 6     6   59 use warnings;
  6         29  
  6         1497  
11              
12             =head1 NAME
13              
14             Ekahau::Response::MapImage - Contains a map of a location
15              
16             =head1 SYNOPSIS
17              
18             Ekahau stores a map of the areas it can find locations in, and this
19             object contains one of those maps. The maps are simply a bitmap image
20             of the area, and are encoded in PNG format.
21              
22             =head1 DESCRIPTION
23              
24             =head2 Constructor
25              
26             Generally you will not want to construct these objects yourself; they
27             are created by L, and use its constructor.
28              
29             =head2 Methods
30              
31             =cut
32              
33             # Internal
34             sub init
35             {
36 0 0   0 0   warn "Created Ekahau::Response::MapImage object\n"
37             if ($ENV{VERBOSE});
38             }
39              
40             =head3 map_size ( )
41              
42             Returns the size of the map image in bytes.
43              
44             =cut
45              
46             sub map_size ( )
47             {
48 0     0 1   my $self = shift;
49 0           return $self->{params}{size};
50             }
51              
52             =head3 map_type ( )
53              
54             Returns the data type of the map image. At the time of this writing,
55             this is always C.
56              
57             =cut
58              
59             sub map_type
60             {
61 0     0 1   my $self = shift;
62 0           return $self->{params}{type};
63             }
64              
65             =head3 map_image ( )
66              
67             Returns the data for this map, in PNG format.
68              
69             =cut
70              
71             sub map_image
72             {
73 0     0 1   my $self = shift;
74 0           return $self->{params}{data};
75             }
76              
77             =head3 type ( )
78              
79             Returns the string I, to identify the type of this object.
80              
81             =cut
82              
83             sub type
84             {
85 0     0 1   'MapImage';
86             }
87              
88             =head1 AUTHOR
89              
90             Scott Gifford Egifford@umich.eduE, Esgifford@suspectclass.comE
91              
92             Copyright (C) 2005 The Regents of the University of Michigan.
93              
94             See the file LICENSE included with the distribution for license
95             information.
96              
97              
98             =head1 SEE ALSO
99              
100             L, L.
101              
102             =cut
103              
104             1;