Ekahau::Response::Area - Represents a single area contained in an Ekahau response

Ekahau documentation Contained in the Ekahau distribution.

Index

Code Index:

NAME

Top

Ekahau::Response::Area - Represents a single area contained in an Ekahau response

SYNOPSIS

Top

Contains information about a single area, generally from an Ekahau::Response::AreaList or Ekahau::Response::AreaEstimate object. Generally you'll be interested in the Properties.

DESCRIPTION

Top

Constructor

Generally you will not want to construct these objects yourself; they are created by Ekahau::Response, and use its constructor.

Methods

get_props ( @prop_names )

Inherited from Ekahau::Response::get_props. Returns a hash containing the values for the list of Properties in @prop_names. If @prop_names is empty, all properties will be returned.

get_prop ( $prop_name )

Inherited from Ekahau::Response::get_prop. Returns the value for one of this object's Properties, specified by $prop_name. If no property named $prop_name exists, undef is returned.

type ( )

Returns the string Area, to identify the type of this object.

Properties

Properties can be retreived with get_prop or get_props. The list of properties below may not be complete, and not all properties will be available for all objects. Property names are case-sensitive.

name

The name of the area.

contextId

Identifies the location context, which can be used to obtain more information about this area with Ekahau::get_location_context (Ekahau::get_location_context) or Ekahau::Base::request_location_context (Ekahau::Base::request_location_context).

polygon

A string representing the vertices of the polygon containing this area. The format is:

    x1;x2;x3&y1;y2;y3

where the points are (x1,y1), (x2,y2), and (x3, y3).

probability

For areas obtained from Ekahau::Response::AreaEstimate objects, contains the probability that the tracked device is in this area.

AUTHOR

Top

Scott Gifford <gifford@umich.edu>, <sgifford@suspectclass.com>

Copyright (C) 2005 The Regents of the University of Michigan.

See the file LICENSE included with the distribution for license information.

SEE ALSO

Top

Ekahau::Response.

Ekahau documentation Contained in the Ekahau distribution. 
package Ekahau::Response::Area;
use base 'Ekahau::Response'; our $VERSION=Ekahau::Response::VERSION;

# Written by Scott Gifford <gifford@umich.edu>
# Copyright (C) 2004 The Regents of the University of Michigan.
# See the file LICENSE included with the distribution for license
# information.

use strict;
use warnings;


# Internal function
sub init
{
    warn "Created Ekahau::Response::Area object\n"
	if ($ENV{VERBOSE});
}


sub type
{
    'Area';
}



1;