Ekahau::Response::AreaEstimate - A list of areas where a tracked object may be

Ekahau documentation Contained in the Ekahau distribution.

Index

Code Index:

NAME

Top

Ekahau::Response::AreaEstimate - A list of areas where a tracked object may be

SYNOPSIS

Top

Contains information about the areas where a tracked object might be. This class inherits both Ekahau::Response and Ekahau::Response::AreaList, and methods from both classes can be used on this object. It's likely that the Ekahau::Response::AreaList::get and Ekahau::Response::AreaList::get_all methods will prove useful.

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 ( @which_props )

Gets the properties of the first Ekahau::Area (Ekahau::Area) object in the list, using Ekahau::Area::get_props (get_props in Ekahau::Area). This convenience method is provided because the first area is the most likely location of the device, and because it's common to request only one area.

get_prop ( $which_prop )

Gets the properties of the first Ekahau::Area (Ekahau::Area) object in the list, using Ekahau::Area::get_prop (get_prop in Ekahau::Area). This convenience method is provided because the first area is the most likely location of the device, and because it's common to request only one area.

type ( )

Returns the string AreaEstimate, to identify the type of this object. Note that subclasses of this class will override this method, returning their own type string.

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::Base.

Ekahau documentation Contained in the Ekahau distribution. 
package Ekahau::Response::AreaEstimate;
use base 'Ekahau::Response::AreaList'; our $VERSION=Ekahau::Response::AreaList::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 method
sub init
{
    my $self = shift;
    warn "Created Ekahau::Response::AreaEstimate object\n"
	if ($ENV{VERBOSE});
    $self->SUPER::init(@_);
}



sub get_props
{
    my $self = shift;

    # Get properties for first estimate
    $self->{_areas}[0]->get_props(@_);
}


sub get_prop
{
    my $self = shift;

    # Get property for first estimate
    $self->{_areas}[0]->get_prop(@_);
}


sub type
{
    'AreaEstimate';
}


1;