Package noaa.coastwatch.io

Class NOAA1bReader.ArchiveHeader

java.lang.Object

noaa.coastwatch.io.NOAA1bReader.ArchiveHeader

Direct Known Subclasses:

NOAA1bV1Reader.ArchiveHeaderV1, NOAA1bV2Reader.ArchiveHeaderV2

Enclosing class:

NOAA1bReader

public abstract class NOAA1bReader.ArchiveHeader
extends Object

The archive header class may be used to retrieve specific data from the archive header of the dataset. Note that not all datasets have archive headers.

See Also:

• NOAA1bReader.isArchive()

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteBuffer	data	The archive header data.
static final int	DATASET_NAME	The official archive dataset name attribute (String).
static final int	DURATION_MINUTES	The dataset duration in minutes attribute (Integer).
static final int	SENSOR_DATA_WORD_SIZE	The sensor data word size attribute: 8, 10, or 16 bits (Integer).
static final int	START_HOUR	The dataset starting hour attribute: [0..23] (Integer).
static final int	START_MINUTE	The dataset starting minute attribute: [00..59] (Integer).

Constructor Summary

Constructors

Constructor	Description
ArchiveHeader()	Creates a new archive header.

Method Summary

Modifier and Type	Method	Description
abstract Object	getAttribute(int index)	Gets a header attribute.
ByteBuffer	getRawData()	Gets the raw header data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DATASET_NAME

public static final int DATASET_NAME

The official archive dataset name attribute (String).

See Also:

• Constant Field Values

START_HOUR

public static final int START_HOUR

The dataset starting hour attribute: [0..23] (Integer).

See Also:

• Constant Field Values

START_MINUTE

public static final int START_MINUTE

The dataset starting minute attribute: [00..59] (Integer).

See Also:

• Constant Field Values

DURATION_MINUTES

public static final int DURATION_MINUTES

The dataset duration in minutes attribute (Integer).

See Also:

• Constant Field Values

SENSOR_DATA_WORD_SIZE

public static final int SENSOR_DATA_WORD_SIZE

The sensor data word size attribute: 8, 10, or 16 bits (Integer).

See Also:

• Constant Field Values

data

protected ByteBuffer data

The archive header data.

Constructor Details

ArchiveHeader

public ArchiveHeader()
              throws IOException

Creates a new archive header.

Throws:

IOException - if an error occurred reading the file data.

Method Details

getRawData

public ByteBuffer getRawData()

Gets the raw header data.

getAttribute

public abstract Object getAttribute(int index)

Gets a header attribute.

Parameters:

index - the attribute index.

Returns:

the attribute as an object. Primitive types are wrapped in their corresponding objects.