NAME

VOTABLE::BINARY - VOTABLE BINARY XML element class


SYNOPSIS

 use VOTABLE::BINARY;


DESCRIPTION

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)>

Methods

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.

get_content($offset, $length)

Return a portion of the content string starting at $offset bytes and continuing for $length bytes. If $offset and $length are not specified, return the entire content as a single byte string. If $offset is specified but $length is not, return the content from $offset to the end of the string. Otherwise, the $offset and $length arguments are treated the same as the corresponding arguments to the substr subroutine. Return the content as a string, or undef if an error occurs.

set_content($bytes, $offset, $length)

Set the specified portion of the content, starting at $offset and continuing for $length bytes, to the specified byte string. If $offset and $length are not specified, the current content is replaced by the specified byte string. If $offset is specified but $length is not specified, $length defaults to the length of $bytes. Otherwise, $offset and $length behave as the corresponding arguments to substr. Return the new string on success, or undef on error.

Notes on class internals


WARNINGS


SEE ALSO

VOTABLE, VOTABLE::DATA, VOTABLE::STREAM


AUTHOR

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


VERSION

$Id: BINARY.pm,v 1.1.1.13 2002/06/09 21:13:08 elwinter Exp $