G. Wade Johnson > Weather-Bug-0.25 > Weather::Bug::Quantity

Download:
Weather-Bug-0.25.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.25   Source  

NAME ^

Weather::Bug::Quantity - Abstraction for a value with units.

VERSION ^

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

SYNOPSIS ^

    use Weather::Bug::Quantity;

    my $q = Weather::Bug::Quantity( -value => 5.1, -units => 'm' );

    print "Distance: $q\n" unless $q->is_null();

DESCRIPTION ^

This class represents numeric values that have associated units. It can also represent a null object for cases where no value was available.

INTERFACE ^

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

Factory Method

from_xml

This class method expects a single XML::LibXML node method with the value being the value of the node and the units specified in units attribute.

Accessor Methods

value

The numeric value represented by the object.

units

The units of the Quantity returned as a string.

is_null

Returns a false value if the Quantity has a value, a true value otherwise.

stringify

Convert the quantity into a printable string (value followed by units) unless the value is null. If the Quantity is null, return N/A.

DIAGNOSTICS ^

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.

syntax highlighting: