File Coverage

blib/lib/Ekahau/Response/LocationContext.pm
Criterion Covered Total %
statement 9 13 69.2
branch 0 2 0.0
condition n/a
subroutine 3 6 50.0
pod 2 3 66.6
total 14 24 58.3


line stmt bran cond sub pod time code
1             package Ekahau::Response::LocationContext;
2 6     6   33 use base 'Ekahau::Response'; our $VERSION=Ekahau::Response::VERSION;
  6         10  
  6         603  
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   33 use strict;
  6         15  
  6         218  
10 6     6   31 use warnings;
  6         13  
  6         1154  
11              
12             =head1 NAME
13              
14             Ekahau::Response::LocationContex - Contains an Ekahau I, with information about a location
15              
16             =head1 SYNOPSIS
17              
18             Ekahau uses I to refer to information about a
19             location returned in an L or
20             L. When you request information about
21             a specific location context, this is the response you'll get.
22              
23             =head1 DESCRIPTION
24              
25             =head2 Constructor
26              
27             Generally you will not want to construct these objects yourself; they
28             are created by L, and use its constructor.
29              
30             =head2 Methods
31              
32             =cut
33              
34             # Internal method
35             sub init
36             {
37 0 0   0 0   warn "Created Ekahau::Response::LocationContext object\n"
38             if ($ENV{VERBOSE});
39             }
40              
41             =head3 get_props ( @prop_names )
42              
43             Inherited from L. Returns a hash
44             containing the values for the list of L in
45             C<@prop_names>. If C<@prop_names> is empty, all properties will be
46             returned.
47              
48             =cut
49              
50             =head3 get_prop ( $prop_name )
51              
52             Inherited from L. Returns the value for
53             one of this object's L, specified by C<$prop_name>. If
54             no property named C<$prop_name> exists, C is returned.
55              
56             =cut
57              
58              
59             =head3 context_id ( )
60              
61             Returns the identifier for this location context.
62              
63             =cut
64              
65             sub context_id
66             {
67 0     0 1   my $self = shift;
68            
69 0           return $self->{args}[0];
70             }
71              
72             =head3 type ( )
73              
74             Returns the string I, to identify the type of this object.
75              
76             =cut
77              
78 0     0 1   sub type { 'LocationContext' }
79              
80             =head2 Properties
81              
82             Properties can be retreived with L or L. The
83             list of properties below may not be complete, and not all properties
84             will be available for all objects. Property names are case-sensitive.
85              
86             =head3 address
87              
88             A short text string describing this location.
89              
90             =head3 mapScale
91              
92             The scale of the map used for this location, in pixels/meter of
93             pixels/foot (depending on configuration).
94              
95              
96             =head1 AUTHOR
97              
98             Scott Gifford Egifford@umich.eduE, Esgifford@suspectclass.comE
99              
100             Copyright (C) 2005 The Regents of the University of Michigan.
101              
102             See the file LICENSE included with the distribution for license
103             information.
104              
105              
106             =head1 SEE ALSO
107              
108             L, L, L.
109              
110             =cut
111              
112             1;