The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Weather-Bug-0.25
River stage zero No dependents
++
/ Weather::Bug::Temperature

NAME

Weather::Bug::Temperature - Abstraction for temperature with the ability to retrieve data in either C or F.

VERSION

This document describes Weather::Bug::Temperature version 0.25

SYNOPSIS

    use Weather::Bug::Temperature;

    my $t = Weather::Bug::Temperature->new( -value => 78, -units => 'F' );

    print "Temperature in Celsius: ", $t->c(), "\n";

DESCRIPTION

Much of the information returned from the WeatherBug API is temperature data. Since normal, outside temperatures can be usefully be returned as values on either the Celsius or Fahrenheit scales, this class serves to abstract that distinction for the user.

INTERFACE

This class supports one factory method and a set of accessor methods.

Factory Method

from_xml

This method expects an XML::LibXML Node object that describes a temperature. Based on the examples in the WeatherBug API, we expect the temperature value to be the value of the node and the units to be specified in the unit attribute.

Accessor Methods

f

Return the value of the temperature on the Fahrenheit scale. The value returned will have the same digits of precision as the original value.

c

Return the value of the temperature on the Celsius scale. The value returned will have the same digits of precision as the original value.

is_SI

Returns a true value if the original temperature was in Celsius, false otherwise.

stringify

Format the temperature and units as a string. If the temperature is null, the string value will be N/A.

DIAGNOSTICS

No node found.

No node was passed to from_xml

Unknown units for temperature.

The supplied units were neither 'C' nor 'F'.

CONFIGURATION AND ENVIRONMENT

Weather::Bug requires no configuration files or environment variables.

DEPENDENCIES

Moose, XML::LibXML.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-weather-weatherbug@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

G. Wade Johnson <wade@anomaly.org>

LICENCE AND COPYRIGHT

Copyright (c) 2008, G. Wade Johnson <wade@anomaly.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.