File Coverage

blib/lib/Ekahau/Response/Area.pm
Criterion Covered Total %
statement 9 11 81.8
branch 0 2 0.0
condition n/a
subroutine 3 5 60.0
pod 1 2 50.0
total 13 20 65.0


line stmt bran cond sub pod time code
1             package Ekahau::Response::Area;
2 6     6   34 use base 'Ekahau::Response'; our $VERSION=Ekahau::Response::VERSION;
  6         12  
  6         536  
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   4127 use strict;
  6         18  
  6         334  
10 6     6   40 use warnings;
  6         11  
  6         983  
11              
12             =head1 NAME
13              
14             Ekahau::Response::Area - Represents a single area contained in an Ekahau response
15              
16             =head1 SYNOPSIS
17              
18             Contains information about a single area, generally from an
19             L or L
20             object. Generally you'll be interested in the L.
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 function
34             sub init
35             {
36 0 0   0 0   warn "Created Ekahau::Response::Area object\n"
37             if ($ENV{VERBOSE});
38             }
39              
40             =head3 get_props ( @prop_names )
41              
42             Inherited from L. Returns a hash
43             containing the values for the list of L in
44             C<@prop_names>. If C<@prop_names> is empty, all properties will be
45             returned.
46              
47             =cut
48              
49             =head3 get_prop ( $prop_name )
50              
51             Inherited from L. Returns the value for
52             one of this object's L, specified by C<$prop_name>. If
53             no property named C<$prop_name> exists, C is returned.
54              
55             =cut
56              
57             =head3 type ( )
58              
59             Returns the string I, to identify the type of this object.
60              
61             =cut
62              
63             sub type
64             {
65 0     0 1   'Area';
66             }
67              
68             =head2 Properties
69              
70             Properties can be retreived with L or L. The
71             list of properties below may not be complete, and not all properties
72             will be available for all objects. Property names are case-sensitive.
73              
74             =head3 name
75              
76             The name of the area.
77              
78             =head3 contextId
79              
80             Identifies the I, which can be used to obtain more
81             information about this area with L or
82             L.
83              
84             =head3 polygon
85              
86             A string representing the vertices of the polygon containing this
87             area. The format is:
88              
89             x1;x2;x3&y1;y2;y3
90              
91             where the points are I<(x1,y1)>, I<(x2,y2)>, and I<(x3, y3)>.
92              
93             =head3 probability
94              
95             For areas obtained from L objects,
96             contains the probability that the tracked device is in this area.
97              
98             =head1 AUTHOR
99              
100             Scott Gifford Egifford@umich.eduE, Esgifford@suspectclass.comE
101              
102             Copyright (C) 2005 The Regents of the University of Michigan.
103              
104             See the file LICENSE included with the distribution for license
105             information.
106              
107              
108             =head1 SEE ALSO
109              
110             L.
111              
112             =cut
113              
114              
115             1;