new($xmldom_element, %options)
get_extnum
set_extnum($extnum)
get_stream
set_stream($votable_stream)
VOTABLE::FITS - VOTABLE FITS XML element class
use VOTABLE::FITS;
This class implements the FITS
element from the VOTABLE
DTD. This element encapsulates FITS-formatted data.
The FITS
element is a Tier 1 element, and is described by the
following excerpt from the VOTABLE
1.0 DTD:
<!ELEMENT FITS (STREAM)> <!ATTLIST FITS extnum CDATA #IMPLIED >
new($xmldom_element, %options)
Create and return a new VOTABLE::FITS
object, based on the supplied
XML::DOM::Element
object, using %options
to set the attributes
of the new object. If no XML::DOM::Element
object is specified, or
is undefined, create and return an empty VOTABLE::FITS
object. Return undef if an error occurs.
get_extnum
Return the value of the extnum
attribute. Return undef
if the
attribute has not been set, or an error occurs.
set_extnum($extnum)
Set the value of the extnum
attribute to the specified
value. Return the new value of the attribute on success, or undef
if an error occurs.
get_stream
Return the VOTABLE::STREAM
object for the STREAM
element which
is the child of this FITS
element. Return undef
if no STREAM
element is found, or an error occurs.
set_stream($votable_stream)
Set the STREAM
element for this FITS
element using the supplied
VOTABLE::STREAM
object. Return the VOTABLE::STREAM
object on
success, or undef
if an error occurs.
_
') are for
internal use only, and should not be used outside of the VOTABLE
class hierarchy.
get_XXX
and set_XXX
accessors for attributes
and elements are derived directly from the names of the attributes or
elements, with the attribute name replacing 'XXX'. Attribute and
element names containing embedded hyphens ('-
') use accessors where
the hyphen is mapped to an underscore ('_
') in the name of the
accessor method. This is a necessity, since the hyphen is not a valid
name character in Perl.
FITS STREAM
,
but that capability will be added ASAP.
VOTABLE
object always has an underlying XML::DOM::Element
object. As long as the internal structure is manipulated only by the
publicly-available methods, this should be an adequate assumption. If
a method detects an aberrant case, a warning message is printed (using
the Carp::carp
subroutine), and the method fails.
XML::DOM
methods always
succeed. If a method detects an aberrant case, a warning message is
printed (using the Carp::carp
subroutine), and the method fails.
set_XXX
accessors do not perform validation of the
new attribute values. The exceptions are the accessors for attributes
with enumerated values; the new value is checked against the list of
acceptable values, as defined in the DTD.
VOTABLE
, VOTABLE::DATA
, VOTABLE::STREAM
Eric Winter, NASA GSFC (elwinter@milkyway.gsfc.nasa.gov)
$Id: FITS.pm,v 1.1.1.10 2002/06/09 21:13:08 elwinter Exp $