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

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

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(), "
";
	 print "This is relatively ", $currconditions->uv_index()->description(), "
";

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 cur-
       rent 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-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::UVIndex(3pm)

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)