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::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