VOTABLE::BINARY - VOTABLE BINARY XML element class
use VOTABLE::BINARY
;
This class implements the BINARY
element from the VOTABLE
DTD. This element encapsulates a stream of binary data (non-FITS).
The BINARY
element is a Tier 1 element, and is described by the
following excerpt from the VOTABLE
1.0 DTD:
<!ELEMENT BINARY (STREAM)>
new($xmldom_element, %options)
Create and return a new VOTABLE::BINARY
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::BINARY
object. Return undef if an error occurs.
get_stream
Return the VOTABLE::STREAM
object for the STREAM
element which
is the child of this BINARY
element. Return undef
if no
STREAM
element is found, or an error occurs.
set_stream($votable_stream)
Set the STREAM
element for this BINARY
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. 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.
BINARY
STREAM
, but that capability will be added ASAP.
VOTABLE::BINARY
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: BINARY.pm,v 1.1.1.8 2002/05/21 14:07:47 elwinter Exp $