Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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

NAME

       Weather::Com::Simple - Simple Wrapper around the Weather::Com::Cached API

SYNOPSIS

	 use Data::Dumper;
	 use Weather::Com::Simple;

	 # define parameters for weather search
	 my %params = (
		       'partner_id' => 'somepartnerid',
		       'license'    => '12345678',
		       'place'	    => 'Heidelberg',
	 );

	 # instantiate a new weather.com object
	 my $simple_weather = Weather::Com::Simple->new(%params);

	 my $weather = $simple_weather->get_weather();

	 print Dumper($weather);

DESCRIPTION

       Weather::Com::Simple is a very high level wrapper around Weather::Com::Cached.  You provide a place to search for (e.g. a city or "city,
       country") and you'll get back a simple hash containing some usefull weather information about all locations whose name matches to the
       search string.

CONSTRUCTOR

       new(hash or hashref)

       The constructor takes the same hash or hashref as Weather::Com::Cached does.  Please refer to that documentation for further details.

       Except from the Weather::Com::Cached parameters this constructor takes a parameter place which defines the location to search for. It is
       not possible to provide the location to search to the get_weather() method!

METHODS

       get_weather()

       This method invokes the Weather::Com::Cached API to fetch some weather information and returns an arrayref containing one or many hashrefs
       with some high level weather information.

       If no location matching the search string is found, it returns undef.

       When you construct a Weather::Com::Simple object like shown in the synopsis above, the arrayref returned has the following structure:

	 $VAR1 = [
		       {
			       'place'	    => 'Heidelberg, Germany',
			       'celsius'		=> '0',
			       'fahrenheit'		=> '32',
			       'temperature_celsius'	=> '0',
			       'temperature_fahrenheit' => '32'
			       'windchill_celsius'	=> '-6',
			       'windchill_fahrenheit'	=> '21',
			       'windspeed_kmh'		=> '26',
			       'windspeed_mph'		=> '16',
			       'wind'	    => '16 mph 26 km/h from the North Northeast',
			       'updated'    => '11:50 AM Local on January 26, 2005',
			       'conditions' => 'Partly Cloudy',
			       'pressure'   => '30.21 in / 1023.0 hPa',
			       'humidity'   => '60',
		       },
		       {
			       'place' => 'Heidelberg, KY',

			       ...

		       },
		       {
			       'place' => 'Heidelberg, MS',

			       ...

		       }
	       ];

SEE ALSO

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

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::Simple(3pm)

Check Out this Related Man Page

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

NAME

       Weather::Com::DayPart - class representing daytime or night part of a forecast

SYNOPSIS

	 [...]

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

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

	 print "Forecast for tomorrow night:
";
	 print " - conditions will be ", $tomorrow_night->conditions(), "
";
	 print " - humidity will be ", $tomorrow_night->humidity(), "\%
";
	 print " - wind speed will be ", $tomorrow_night->wind()->speed(), "km/h
";

DESCRIPTION

       Via Weather::Com::DayPart objects one can access the daytime or night part of a Weather::Com::DayForecast.

       This class will not be updated automatically with each call to one of its methods. You need to call a method of your Weather::Com::Forecast
       object to get updated objects.

CONSTRUCTOR

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

METHODS

       type([$language])

       Will return day or night.

       This attribute is dynamic language enabled.

       conditions([$language])

       Will return a textual description of the forecasted conditions.

       This attribute is dynamic language enabled.

       humidity()

       Will return the humidity.

       icon()

       Will return the icon number of the icon describing the forecasted weather.

       precipitation()

       Will return the percentage chance of precipitation.

       wind()

       Will return a Weather::Com::Wind object.

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::DayPart(3pm)
Man Page