Bob Ernst > Weather-Com-2.0.0 > Weather::Com::UVIndex

Download:
Weather-Com-2.0.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  1
View/Report Bugs
Module Version: 1.002   Source  

NAME ^

Weather::Com::UVIndex - class containing the uv index data

SYNOPSIS ^

  #!/usr/bin/perl -w
  use Weather::Com::Finder;

  # you have to fill in your ids from weather.com here
  my $PartnerId  = 'somepartnerid';
  my $LicenseKey = 'mylicense';

  my %weatherargs = (
        'partner_id' => $PartnerId,
        'license'    => $LicenseKey,
        'language'   => 'de',
  );

  my $weather_finder = Weather::Com::Finder->new(%weatherargs);
  
  my @locations = $weather_finder->find('Heidelberg');

  my $currconditions = $locations[0]->current_conditions();

  print "The current uv index is ", $currconditions->uv_index()->index(), "\n";
  print "This is relatively ", $currconditions->uv_index()->description(), "\n";  

DESCRIPTION ^

Via Weather::Com::UVIndex one can access the uv index and its description (whether it's high or low). An uv index is usually an object belonging to current conditions or to a forecast (not implemented yet).

This class will not be updated automatically with each call to one of its methods. You need to call the uv_index() method of the parent object again to update your object.

CONSTRUCTOR ^

You usually would not construct an object of this class yourself. This is implicitely done when you call the uv_index() method of one current conditions or forecast object.

METHODS ^

index()

Returns the uv index (number).

description([$language])

Returns the description whether this index is high or low.

This description is translated if you specified the language option as argument while instantiating your Weather::Com::Finder.

This attribute is dynamic language enabled.

AUTHOR ^

Thomas Schnuecker, <thomas@schnuecker.de>

COPYRIGHT AND LICENSE ^

Copyright (C) 2004-2009 by Thomas Schnuecker

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The data provided by weather.com and made accessible by this OO interface can be used for free under special terms. Please have a look at the application programming guide of weather.com (http://www.weather.com/services/xmloap.html)!

syntax highlighting: