File Coverage

blib/lib/Ekahau/Response/AreaEstimate.pm
Criterion Covered Total %
statement 9 17 52.9
branch 0 2 0.0
condition n/a
subroutine 3 7 42.8
pod 3 4 75.0
total 15 30 50.0


line stmt bran cond sub pod time code
1             package Ekahau::Response::AreaEstimate;
2 6     6   33 use base 'Ekahau::Response::AreaList'; our $VERSION=Ekahau::Response::AreaList::VERSION;
  6         14  
  6         4056  
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   41 use strict;
  6         12  
  6         190  
10 6     6   29 use warnings;
  6         13  
  6         1349  
11              
12             =head1 NAME
13              
14             Ekahau::Response::AreaEstimate - A list of areas where a tracked object may be
15              
16             =head1 SYNOPSIS
17              
18             Contains information about the areas where a tracked object might be.
19             This class inherits both L and L,
20             and methods from both classes can be used on this object. It's likely
21             that the L and
22             L methods will prove useful.
23              
24             =head1 DESCRIPTION
25              
26             =head2 Constructor
27              
28             Generally you will not want to construct these objects yourself; they
29             are created by L, and use its constructor.
30              
31             =head2 Methods
32              
33             =cut
34              
35             # Internal method
36             sub init
37             {
38 0     0 0   my $self = shift;
39 0 0         warn "Created Ekahau::Response::AreaEstimate object\n"
40             if ($ENV{VERBOSE});
41 0           $self->SUPER::init(@_);
42             }
43              
44              
45             =head3 get_props ( @which_props )
46              
47             Gets the properties of the first L object in the list,
48             using L. This convenience method is provided
49             because the first area is the most likely location of the device, and
50             because it's common to request only one area.
51              
52             =cut
53              
54             sub get_props
55             {
56 0     0 1   my $self = shift;
57              
58             # Get properties for first estimate
59 0           $self->{_areas}[0]->get_props(@_);
60             }
61              
62             =head3 get_prop ( $which_prop )
63              
64             Gets the properties of the first L object in the list,
65             using L. This convenience method is provided
66             because the first area is the most likely location of the device, and
67             because it's common to request only one area.
68              
69             =cut
70              
71             sub get_prop
72             {
73 0     0 1   my $self = shift;
74              
75             # Get property for first estimate
76 0           $self->{_areas}[0]->get_prop(@_);
77             }
78              
79             =head3 type ( )
80              
81             Returns the string I, to identify the type of this
82             object. Note that subclasses of this class will override this method,
83             returning their own type string.
84              
85             =cut
86              
87             sub type
88             {
89 0     0 1   'AreaEstimate';
90             }
91              
92             =head1 AUTHOR
93              
94             Scott Gifford Egifford@umich.eduE, Esgifford@suspectclass.comE
95              
96             Copyright (C) 2005 The Regents of the University of Michigan.
97              
98             See the file LICENSE included with the distribution for license
99             information.
100              
101             =head1 SEE ALSO
102              
103             L, L.
104              
105             =cut
106              
107             1;