.\" 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::Location 3pm"
.TH Weather::Com::Location 3pm "2007-07-09" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Weather::Com::Location \- class representing one location and its weather
.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 4
\&  my %weatherargs = (
\&        \(aqpartner_id\(aq => $PartnerId,
\&        \(aqlicense\(aq    => $LicenseKey,
\&  );
.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 2
\&  # or if you prefer an arrayref:
\&  my $locations = $finder\->find(\(aqHeidelberg\(aq);
.Ve
.PP
.Vb 6
\&  foreach my $location (@locations) {
\&    print "Found weather for city: ", $location\->name(), "\en";
\&    print "The city is located at: ", $location\->latitude(), "deg N, ",
\&                  $location\->longitude(), "deg E\en";
\&        print "Local time is ", $location\->localtime()\->time(), "\en";
\&        print "Sunrise will be/has been at ", $location\->sunrise()\->time(), "\en";
.Ve
.PP
.Vb 1
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Using \fIWeather::Com::Location\fR objects is the way to access weather (and 
some location) information for one specific location (city).
.PP
You get \fIWeather::Com::Location\fR objects by using a finder object
(see Weather::Com::Finder).
.PP
\&\fIWeather::Com::Location\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 ready
to use location objects by using a finder.
.PP
If you ever want to instantiate location 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 location.
.Sh "\fIname()\fP"
.IX Subsection "name()"
Returns the name of the location as provided by \fIweather.com\fR.
.Sh "\fIcurrent_conditions()\fP"
.IX Subsection "current_conditions()"
Returns a \fIWeather::Com::CurrentConditions\fR object containing the 
current conditions of the location.
.PP
The \fIWeather::Com::CurrentConditions\fR object is instantiated with
the first call of the \f(CW\*(C`current_conditions()\*(C'\fR method.
.PP
Please refer to Weather::Com::CurrentConditions for further
details.
.Sh "\fIforecast()\fP"
.IX Subsection "forecast()"
Returns a \fIWeather::Com::Forecast\fR object.
.PP
Please refer to Weather::Com::Forecast for further details.
.Sh "\fIlatitude()\fP"
.IX Subsection "latitude()"
Returns the latitude of the location.
.Sh "\fIlongitude()\fP"
.IX Subsection "longitude()"
Returns the longitude of the location.
.Sh "\fIlocaltime()\fP"
.IX Subsection "localtime()"
Returns a Weather::Com::DateTime object containing the local time
of the location.
.PP
This value is evaluated each time you call this method. We do not use
the value returned from \fIweather.com\fR here because it does not make
any sence to use a cached value to show the current time.
.Sh "\fIlocaltime_ampm()\fP"
.IX Subsection "localtime_ampm()"
\&\fBThis method is deprecated and will be removed with the next release!\fR
.PP
Returns the local time of the location.
.PP
The time is returned in the format \f(CW\*(C`hh:mm [AM|PM]\*(C'\fR.
To get a 24 hour format use \f(CW\*(C`localtime\*(C'\fR instead.
.PP
.Vb 1
\&  Sample: 10:30 PM
.Ve
.Sh "\fIsunrise()\fP"
.IX Subsection "sunrise()"
Returns a Weather::Com::DateTime object containing the time of sunrise.
.Sh "\fIsunrise_ampm()\fP"
.IX Subsection "sunrise_ampm()"
\&\fBThis method is deprecated and will be removed with the next release!\fR
.PP
Returns the time of sunrise in 12 hour format (see \f(CW\*(C`localtime_ampm()\*(C'\fR
for details).
.Sh "\fIsunset()\fP"
.IX Subsection "sunset()"
Returns a Weather::Com::DateTime object containing the time of sunset.
.Sh "\fIsunset_ampm()\fP"
.IX Subsection "sunset_ampm()"
\&\fBThis method is deprecated and will be removed with the next release!\fR
.PP
Returns the time of sunset in 12 hour format (see \f(CW\*(C`localtime_ampm()\*(C'\fR
for details).
.Sh "\fItimezone()\fP"
.IX Subsection "timezone()"
Returns the timezone offset to \s-1GMT\s0 (without respecting 
daylight savings time).
.Sh "\fIunits()\fP"
.IX Subsection "units()"
Returns a \fIWeather::Com::Units\fR object.
.PP
Please refer to Weather::Com::Units for further
details.
.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, <thomas@schnuecker.de>
.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)