trusty (3) Weather::Com::Forecast.3pm.gz

Provided by: libweather-com-perl_0.5.3-2_all bug

NAME
       Weather::Com::Forecast - class representing all available weather forecasts for one location


SYNOPSIS
         [...]

         my @locations = $weather_finder->find('Heidelberg');

         my $forecast = $locations[0]->forecast();
         my $tomorrow = $forecast->day(1);

         print "Forecast for tomorrow:\n";
         print " - tomorrow it's the ", $tomorrow->date()->date(), "\n";
         print " - sunrise will be at ", $tomorrow->sunrise()->time(), "\n";
         print " - maximum temperature will be ", $tomorrow->high(), "\n";


DESCRIPTION
       Using Weather::Com::Forecast objects is the way to access weather forecast information for one specific
       location (city) and 0 (today) to 9 days in the future.

       Each time you call the Weather::Com::Location objects' "forecast()" method, you'll get an updated
       Weather::Com::Forecast object. This object is used to access the 10 Weather::Com::DayForecast objects
       containing the actual data.


CONSTRUCTOR
       new(hash or hashref)

       You usually would not construct an object of this class yourself.  This is implicitely done when you call
       the "forecast()" method of a Weather::Com::Location object.


METHODS
       all()

       Returns an arrayref of all Weather::Com::DayForecast objects if called in scalar context, an array if
       called in list context.

       day(day number)

       Returns the Weather::Com::DayForecast object that corresponds to the day number you provided.

       The day number can be any number between 0 and 9.

       Day 0 is usually today. Due to a bug (I think it is one) in the weather.com XOAP API, you may get the
       full forecast data of yesterday if you call for day 0 just after midnight. I think this may have do
       something with the timezone.  I have not fully investigated this issue, yet. Please contact me, if you
       have!


SEE ALSO
       See also documentation of Weather::Com, Weather::Com::Location, Weather::Com::DayForecast.


AUTHOR
       Thomas Schnuecker, <thomas@schnuecker.de>


       Copyright (C) 2004-2007 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)