Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

weather::com::forecast(3pm) [debian man page]

Weather::Com::Forecast(3pm)				User Contributed Perl Documentation			       Weather::Com::Forecast(3pm)

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:
";
	 print " - tomorrow it's the ", $tomorrow->date()->date(), "
";
	 print " - sunrise will be at ", $tomorrow->sunrise()->time(), "
";
	 print " - maximum temperature will be ", $tomorrow->high(), "
";

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 AND LICENSE

       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)

perl v5.8.8							    2007-07-09					       Weather::Com::Forecast(3pm)

Check Out this Related Man Page

Weather::Com::Finder(3pm)				User Contributed Perl Documentation				 Weather::Com::Finder(3pm)

NAME

       Weather::Com::Finder - finder class to search for weather.com location's

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,
	 );

	 my $finder = Weather::Com::Finder->new(%weatherargs);

	 # if you want an array of locations:
	 my @locations = $finder->find('Heidelberg');

	 # or if you prefer an arrayref:
	 my $locations = $finder->find('Heidelberg');

	 foreach my $location (@locations) {
	   print "Found weather for city: ", $location->name(), "
";
	   print "Current Conditions are ",
	     $location->current_conditions()->description(), "
";
	 }

DESCRIPTION

       The usual way to use the Weather::Com module would be to instantiate a Weather::Com::Finder that allows you to search for a location by
       providing a search string or postal code or any other search string that weather.com understands.

       The finder returns an arrayref or an array of locations (depending on how you call the "find()" method). Each location is an object of
       Weather::Com::Location.

CONSTRUCTOR

       new(hash or hashref)

       The constructor takes a configuration hash or hashref as described in the Weather::Com POD. Please refer to that documentation for further
       details.

METHODS

       find(search string)

       Once you've instantiated a finder object, you can perform "find()" calls to search for locations in the weather.com database.

       The "find()" method returns an array of Weather::Com::Location objects if you call it in list context, else an arrayref.

       Returns undef if no matching location could be found.

SEE ALSO

       See also documentation of Weather::Com and Weather::Com::Location.

AUTHOR

       Thomas Schnuecker, <thomas@schnuecker.de>

COPYRIGHT AND LICENSE

       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)

perl v5.8.8							    2007-07-09						 Weather::Com::Finder(3pm)
Man Page