File Coverage

blib/lib/Ekahau/Response/DeviceProperties.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::DeviceProperties;
2 6     6   34 use base 'Ekahau::Response'; our $VERSION=Ekahau::Response::VERSION;
  6         11  
  6         554  
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   34 use strict;
  6         15  
  6         195  
10 6     6   30 use warnings;
  6         19  
  6         2269  
11              
12             =head1 NAME
13              
14             Ekahau::Response::DeviceProperties - Properties of a device tracked by Ekahau
15              
16             =head1 SYNOPSIS
17              
18             Contains the properties of a device visible to Ekahau.
19              
20             =head1 DESCRIPTION
21              
22             =head2 Constructor
23              
24             Generally you will not want to construct these objects yourself; they
25             are created by L, and use its constructor.
26              
27             =head2 Methods
28              
29             =cut
30              
31             # Internal method
32             sub init
33             {
34 0 0   0 0   warn "Created Ekahau::Response::DeviceProperties object\n"
35             if ($ENV{VERBOSE});
36             }
37              
38             =head3 get_props ( @prop_names )
39              
40             Inherited from L. Returns a hash
41             containing the values for the list of L in
42             C<@prop_names>. If C<@prop_names> is empty, all properties will be
43             returned.
44              
45             =cut
46              
47             =head3 get_prop ( $prop_name )
48              
49             Inherited from L. Returns the value for
50             one of this object's L, specified by C<$prop_name>. If
51             no property named C<$prop_name> exists, C is returned.
52              
53             =cut
54              
55             =head3 device_id ( )
56              
57             Returns the identifier for this device, which can be used to start or
58             stop tracking.
59              
60             =cut
61              
62             sub device_id
63             {
64 0     0 1   my $self = shift;
65            
66 0           return $self->{args}[0];
67             }
68              
69             =head3 type ( )
70              
71             Returns the string I, to identify the type of this object.
72              
73             =cut
74              
75             sub type
76             {
77 0     0 1   'DeviceProperties';
78             }
79              
80              
81             =head2 Properties
82              
83             Properties can be retreived with L or L. The
84             list of properties below may not be complete, and not all properties
85             will be available for all objects. Property names are case-sensitive.
86              
87             =head3 ECLIENT.WLAN_MODEL
88              
89             The model of wireless card contained in the device.
90              
91             =head3 ECLIENT.COMMON_INTERNALNAME
92              
93             The name of the Ekahau driver used on the device.
94              
95             =head3 NETWORK.MAC
96              
97             The MAC address of the device.
98              
99             =head3 NETWORK.DNS_NAME
100              
101             The network name of the device.
102              
103             =head3 NETWORK.IP-ADDRESS
104              
105             The IP address of the device.
106              
107              
108             =head1 AUTHOR
109              
110             Scott Gifford Egifford@umich.eduE, Esgifford@suspectclass.comE
111              
112             Copyright (C) 2005 The Regents of the University of Michigan.
113              
114             See the file LICENSE included with the distribution for license
115             information.
116              
117              
118             =head1 SEE ALSO
119              
120             L, L, L.
121              
122             =cut
123              
124             1;