nom.tam.fits

Interface FitsElement

All Known Implementing Classes:

AsciiTable, AsciiTableHDU, BasicHDU, BinaryTable, BinaryTableHDU, Data, FitsHeap, Header, ImageData, ImageHDU, RandomGroupsData, RandomGroupsHDU, TableHDU, UndefinedData, UndefinedHDU

public interface FitsElement

Method Summary

Methods

Modifier and Type	Method and Description
long	getFileOffset() Get the byte at which this element begins.
long	getSize() The size of this element in bytes
void	read(ArrayDataInput in) Read the contents of the element from an input source.
boolean	reset() Reset the input stream to point to the beginning of this element
void	rewrite() Rewrite the contents of the element in place.
boolean	rewriteable() Can this element be rewritten?
void	write(ArrayDataOutput out) Write the contents of the element to a data sink.

Method Detail

read

void read(ArrayDataInput in)
          throws FitsException,
                 java.io.IOException

Read the contents of the element from an input source.

Parameters:

in - The input source.

Throws:

FitsException

java.io.IOException

write

void write(ArrayDataOutput out)
           throws FitsException,
                  java.io.IOException

Write the contents of the element to a data sink.

Parameters:

out - The data sink.

Throws:

FitsException

java.io.IOException

rewrite

void rewrite()
             throws FitsException,
                    java.io.IOException

Rewrite the contents of the element in place. The data must have been orignally read from a random access device, and the size of the element may not have changed.

Throws:

FitsException

java.io.IOException

getFileOffset

long getFileOffset()

Get the byte at which this element begins. This is only available if the data is originally read from a random access medium.

rewriteable

boolean rewriteable()

Can this element be rewritten?

getSize

long getSize()

The size of this element in bytes

reset

boolean reset()

Reset the input stream to point to the beginning of this element

Returns:

True if the reset succeeded.