Ekahau::Response::MapImage - Contains a map of a location

Ekahau documentation Contained in the Ekahau distribution.

Index

Code Index:

NAME

Top

Ekahau::Response::MapImage - Contains a map of a location

SYNOPSIS

Top

Ekahau stores a map of the areas it can find locations in, and this object contains one of those maps. The maps are simply a bitmap image of the area, and are encoded in PNG format.

DESCRIPTION

Top

Constructor

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

Methods

map_size ( )

Returns the size of the map image in bytes.

map_type ( )

Returns the data type of the map image. At the time of this writing, this is always png.

map_image ( )

Returns the data for this map, in PNG format.

type ( )

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

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::MapImage;
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
sub init
{
    warn "Created Ekahau::Response::MapImage object\n"
	if ($ENV{VERBOSE});
}


sub map_size ( )
{
    my $self = shift;
    return $self->{params}{size};
}


sub map_type
{ 
    my $self = shift;
    return $self->{params}{type};
}


sub map_image
{
    my $self = shift;
    return $self->{params}{data};
}


sub type
{
    'MapImage';
}


1;