File Coverage

blib/lib/Ekahau/Response/LocationEstimate.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::LocationEstimate;
2 6     6   40 use base 'Ekahau::Response'; our $VERSION=Ekahau::Response::VERSION;
  6         9  
  6         807  
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   36 use strict;
  6         12  
  6         218  
10 6     6   40 use warnings;
  6         55  
  6         819  
11              
12              
13             =head1 NAME
14              
15             Ekahau::Response::LocationEstimate - Contains an estimate of an object's location
16              
17             =head1 SYNOPSIS
18              
19             When an object is being tracked by Ekahau, you'll receive periodic
20             estimates of its location, in the form of these objects.
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 method
34             sub init
35             {
36 0 0   0 0   warn "Created Ekahau::Response::LocationEstimate 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   'LocationEstimate';
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 accurateX
75              
76             The X coordinate of the most accurate position information available
77             for the device. The extra accuracy comes at the expense of some
78             additional time to gather and process information, so the information
79             may be slightly older than that available in L
80              
81             =head3 accurateY
82              
83             The X coordinate of the most accurate position information available
84             for the device.
85              
86             =head3 accurateTime
87              
88             The time of the last accurate position information update.
89              
90             =head3 accurateContextId
91              
92             The location context of the last accurate position information update.
93              
94             =head3 accurateExpectedError
95              
96             The expected error of the last accurate position information update,
97             in meters or feet depending on configuration.
98              
99             =head3 latestX
100              
101             The X coordinate of the latest position information available for the
102             device. The speedy update comes at the expense of some accuracy, so
103             the information may be somewhat inaccurate and jittery. More
104             accurate, but older, information is available in L
105              
106             =head3 latestY
107              
108             The Y coordinate of the latest position information available for the
109             device.
110              
111             =head3 latestTime
112              
113             The time of the last position information update.
114              
115             =head3 latestContexId
116              
117             The location context of the last position information update.
118              
119             =head3 latestExpectedError
120              
121             The expected error of the last accurate position information update,
122             in meters or feet depending on configuration.
123              
124             =head3 speed
125              
126             The speed the device being tracked is moving.
127              
128             =head3 heading
129              
130             The heading of the device being tracked.
131              
132             =head1 AUTHOR
133              
134             Scott Gifford Egifford@umich.eduE, Esgifford@suspectclass.comE
135              
136             Copyright (C) 2005 The Regents of the University of Michigan.
137              
138             See the file LICENSE included with the distribution for license
139             information.
140              
141              
142             =head1 SEE ALSO
143              
144             L, L.
145              
146             =cut
147              
148             1;