.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Weather::Com::CurrentConditions 3pm" .TH Weather::Com::CurrentConditions 3pm "2007-07-09" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Weather::Com::CurrentConditions \- class containing current weather conditions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& #!/usr/bin/perl \-w \& use Weather::Com::Finder; .Ve .PP .Vb 3 \& # you have to fill in your ids from weather.com here \& my $PartnerId = \(aqsomepartnerid\(aq; \& my $LicenseKey = \(aqmylicense\(aq; .Ve .PP .Vb 5 \& my %weatherargs = ( \& \(aqpartner_id\(aq => $PartnerId, \& \(aqlicense\(aq => $LicenseKey, \& \(aqlanguage\(aq => \(aqde\(aq, \& ); .Ve .PP .Vb 1 \& my $finder = Weather::Com::Finder\->new(%weatherargs); .Ve .PP .Vb 2 \& # if you want an array of locations: \& my @locations = $finder\->find(\(aqHeidelberg\(aq); .Ve .PP .Vb 5 \& my $conditions = $locations[0]\->current_conditions(); \& print "Found weather for city: ", $location\->name(), "\en"; \& print "Current conditions are ", $conditions\->description(), "\en"; \& print "Current temperature is ", $conditions\->temperature(), "°C\en"; \& print "... as found out by observatory ", $conditions\->observatory(), "\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Using \fIWeather::Com::CurrentCondition\fR objects provide current weather conditions of its parent object (a location) to you. .PP You get \fIWeather::Com::CurrentConditions\fR objects by calling the method \&\f(CW\*(C`current_conditions()\*(C'\fR of your location object. .PP \&\fIWeather::Com::CurrentConditions\fR is a subclass of \fIWeather::Com::Cached\fR. An instance of this class will update itself corresponding to the caching rules any time one of its methods is called. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .Sh "new(hash or hashref)" .IX Subsection "new(hash or hashref)" The constructor will usually not be used directly because you get a ready to use current conditions objects from your location object. .PP If you ever want to instantiate current conditions objects on your own, you have to provide the same configuration hash or hashref to the constructor you usually would provide to the \f(CW\*(C`new()\*(C'\fR method of \fIWeather::Com::Finder\fR. In addition it is necessary to add a hash element \f(CW\*(C`location_id\*(C'\fR to this config hash. The \f(CW\*(C`location_id\*(C'\fR has to be a valid \fIweather.com\fR location id. .SH "METHODS" .IX Header "METHODS" .Sh "\fIid()\fP" .IX Subsection "id()" Returns the location id used to instantiate this object. .Sh "\fIname()\fP" .IX Subsection "name()" Returns the name of the location this current conditions belong to. .Sh "description([$language])" .IX Subsection "description([$language])" Returns a textual representation of the current weather conditions. .PP This description is translated if you specified the \fIlanguage\fR option as argument for your \fIWeather::Com::Finder\fR. .PP This attribute is \fIdynamic language enabled\fR. .Sh "\fIdewpoint()\fP" .IX Subsection "dewpoint()" Returns the dewpoint. .Sh "\fIhumidity()\fP" .IX Subsection "humidity()" Returns the humidity (in %). .Sh "\fIicon()\fP" .IX Subsection "icon()" Returns the number of the icon that can be used to display the current weather conditions. These icons are available with the \&\fIweather.com\fR sdk. You can download this sdk from \fIweather.com\fR after you've registered to get your license. .Sh "\fIlast_updated()\fP" .IX Subsection "last_updated()" Returns a \fIWeather::Com::DateTime\fR object containing the date and time of the last update as provided by \fIweather.com\fR. .Sh "\fIobservatory()\fP" .IX Subsection "observatory()" Returns the name of the observatory that provided the current conditions to \fIweather.com\fR. .Sh "\fIpressure()\fP" .IX Subsection "pressure()" Returns a \fIWeather::Com::AirPressure\fR object. .PP Please refer to Weather::Com::AirPressure for further details. .Sh "\fItemperature()\fP" .IX Subsection "temperature()" Returns the temperature (depending on how you instantiated your \&\fIWeather::Com::Finder\fR you'll get centigrade (default) or degrees fahrenheit). .Sh "\fIuv_index()\fP" .IX Subsection "uv_index()" Returns a \fIWeather::Com::UVIndex\fR object. .PP Please refer to Weather::Com::UVIndex for further details. .Sh "\fIvisibility()\fP" .IX Subsection "visibility()" Returns the visibility (depending on how you instantiated your \&\fIWeather::Com::Finder\fR you'll get km (default) or miles). .Sh "\fIwind()\fP" .IX Subsection "wind()" Returns a \fIWeather::Com::Wind\fR object. .PP Please refer to Weather::Com::Wind for further details. .Sh "\fIwindchill()\fP" .IX Subsection "windchill()" Returns the windchill temperature (depending on how you instantiated your \&\fIWeather::Com::Finder\fR you'll get centigrade (default) or degrees fahrenheit). .SH "SEE ALSO" .IX Header "SEE ALSO" See also documentation of Weather::Com, Weather::Com::CurrentConditions, Weather::Com::Units. .SH "AUTHOR" .IX Header "AUTHOR" Thomas Schnuecker, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2004\-2007 by Thomas Schnuecker .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP The data provided by \fIweather.com\fR and made accessible by this \s-1OO\s0 interface can be used for free under special terms. Please have a look at the application programming guide of \&\fIweather.com\fR (http://www.weather.com/services/xmloap.html)