Scott Gifford > Ekahau > Ekahau::Response::LocationContex

Download:
Ekahau-0.001.tar.gz

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Ekahau::Response::LocationContex - Contains an Ekahau location context, with information about a location

SYNOPSIS ^

Ekahau uses location contexts to refer to information about a location returned in an Ekahau::Response::AreaList or Ekahau::Response::AreaEstimate. When you request information about a specific location context, this is the response you'll get.

DESCRIPTION ^

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.

context_id ( )

Returns the identifier for this location context.

type ( )

Returns the string LocationContext, 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.

address

A short text string describing this location.

mapScale

The scale of the map used for this location, in pixels/meter of pixels/foot (depending on configuration).

AUTHOR ^

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 ^

Ekahau::Response, Ekahau::Base, Ekahau::Response::Area.

syntax highlighting: