Frank Cox > Geo-ReadGRIB-1.4 > Geo::ReadGRIB::Place

Download:
Geo-ReadGRIB-1.4.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1   Source  

NAME ^

Geo::ReadGRIB::Place - Contains the value of a one or more data type at a given time and geographic location.

VERSION ^

This documentation refers to Geo::ReadGRIB::Place version 1.0 as returned by a call to Geo::ReadGRIB::PlaceIterator::Current()

SYNOPSIS ^

    use Geo::ReadGRIB;

    $w = new Geo::ReadGRIB "grib-file";
    $w->getFullCatalog;

    print $w->show,"\n";
  
    $plit = $w->extractLaLo(data_type, lat1, long1, lat2, long2, time);
    die $w->getError if $w->getError;

    # $plit is a Geo::ReadGRIB::PlaceIterator

    while ( $place = $plit->current() and $plit->next ) {

        # $place is a Geo::ReadGRIB::Place object

        $time       = $place->thisTime;
        $latitude   = $place->lat;
        $longitude  = $place->long;
        $data_types = $place->types; # an array ref of type names

        $data       = $place->data( data_type );

        # process data...
    }

DESCRIPTION ^

Objects of this class are returned by the current() method of a PlaceIterator object which itself has been returned by the extractLaLo() or extract() methods of a Geo::ReadGRIB object. A place object has a unique latitude and longitude for one time and has data for one or more data types.

METHODS ^

Objects of this class are read only and all parameters may be accessed by the following methods.

$object->new;
$object->thisTime;
$object->lat;
$object->long;
$object->types;
$object->data(type);

BUGS AND LIMITATIONS ^

There are no known bugs in this module. Please report problems through

http://rt.cpan.org

or contact Frank Cox, <frank.l.cox@gmail.com> Patches are welcome.

AUTHOR ^

Frank Cox, <frank.l.cox@gmail.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2009 by Frank Cox

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: