NAME

VOTABLE::MAX - VOTABLE MAX XML element class


SYNOPSIS

use VOTABLE::MAX;


DESCRIPTION

This class implements the MAX element from the VOTABLE DTD. This element is used to store maximum values for a numeric quantity.

The MAX element is a Tier 0 element, and is described by the following excerpt from the VOTABLE 1.0 DTD:

 <!ELEMENT MAX (#PCDATA)>
 <!ATTLIST MAX
         value CDATA #REQUIRED
         inclusive (yes | no) "yes"
 >

Methods

new($str_or_ref, %options)

Create a new VOTABLE::MAX object, and return a reference to it. If the first argument ($str_or_ref) is a string, it is used as the initial PCDATA content of the MAX element. If the first argument is a reference to a XML::DOM::Element object, that object is used to initialize the new MAX element (implicitly assuming that the XML::DOM::Element object contains a valid MAX element). The %options hash is used to set the attributes of the new element. If the first argument is missing or undefined, or an empty string, create and return an empty VOTABLE::MAX object. Return undef if an error occurs.

get_inclusive

Return the value of the inclusive attribute. Return undef if the attribute has not been set, or an error occurs.

set_inclusive($inclusive)

Set the value of the inclusive attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_value

Return the value of the value attribute. Return undef if the attribute has not been set, or an error occurs.

set_value($value)

Set the value of the value attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get

Return a string containing the PCDATA content of the MAX element. Return undef if the element has no PCDATA content, or an error occurs.

set($str)

Set the PCDATA content of the MAX element to the specified string. Return the string on success, or undef if an error occurs.

Notes on class internals


WARNINGS


SEE ALSO

VOTABLE, VOTABLE::VALUES


AUTHOR

Eric Winter, NASA GSFC (elwinter@milkyway.gsfc.nasa.gov)


VERSION

$Id: MAX.pm,v 1.1.1.7 2002/05/21 14:11:32 elwinter Exp $