org.das2.qstream

Class PacketDescriptor

java.lang.Object

org.das2.qstream.PacketDescriptor

All Implemented Interfaces:

java.lang.Cloneable, Descriptor

public class PacketDescriptor
extends java.lang.Object
implements Descriptor, java.lang.Cloneable

Method Summary

Modifier and Type	Method and Description
void	addPlane(PlaneDescriptor planeDescriptor)
java.lang.Object	clone()
org.w3c.dom.Element	getDomElement()
int	getPacketId() return the packet ID, which is a number from 1-99.
java.util.List<PlaneDescriptor>	getPlanes() return the list of planes in an unmodifiable list.
boolean	isStream() If true, then slices of the dataset fill each packet.
void	setDomElement(org.w3c.dom.Element packetElement)
void	setPacketId(int packetId) keep track of the packet ID, which is a number from 1-99.
void	setStream(boolean stream)
void	setStreamRank(int streamRank) number of dimensions being streamed.
int	sizeBytes() calculate the number of bytes in each packet.
int	streamRank()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

isStream

public boolean isStream()

If true, then slices of the dataset fill each packet.

setStream

public void setStream(boolean stream)

streamRank

public int streamRank()

setStreamRank

public void setStreamRank(int streamRank)

number of dimensions being streamed. Zero means all the data is found in the first packet (no streaming). One means a qube is being streamed. Two means a this packet is one qube of a higher rank dataset.

addPlane

public void addPlane(PlaneDescriptor planeDescriptor)

getPlanes

public java.util.List<PlaneDescriptor> getPlanes()

return the list of planes in an unmodifiable list.

Returns:

setDomElement

public void setDomElement(org.w3c.dom.Element packetElement)

getDomElement

public org.w3c.dom.Element getDomElement()

Specified by:

getDomElement in interface Descriptor

sizeBytes

public int sizeBytes()

calculate the number of bytes in each packet.

Returns:

getPacketId

public int getPacketId()

return the packet ID, which is a number from 1-99.

Returns:

Throws:

java.lang.IllegalStateException - when the packet ID is invalid (which shouldn't happen)

setPacketId

public void setPacketId(int packetId)

keep track of the packet ID, which is a number from 1-99.

Parameters:

packetId -

Throws:

java.lang.IllegalArgumentException - then the packet ID is invalid.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object