## org.das2.qstream.PacketDescriptor

## addPlane

addPlane( org.das2.qstream.PlaneDescriptor planeDescriptor ) → void

### Parameters

planeDescriptor - a PlaneDescriptor

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## clone

clone( ) → Object

### Returns:

java.lang.Object
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getDomElement

getDomElement( ) → org.w3c.dom.Element

### Returns:

org.w3c.dom.Element
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getPacketId

getPacketId( ) → int

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

### Returns:

an int
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getPlanes

getPlanes( ) → java.util.List

return the list of planes in an unmodifiable list.

### Returns:

a java.util.List
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isStream

isStream( ) → boolean

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

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setDomElement

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

### Parameters

packetElement - an Element

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setPacketId

setPacketId( int packetId ) → void

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

### Parameters

packetId - an int

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setStream

setStream( boolean stream ) → void

### Parameters

stream - a boolean

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setStreamRank

setStreamRank( int streamRank ) → void

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.

### Parameters

streamRank - an int

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## sizeBytes

sizeBytes( ) → int

calculate the number of bytes in each packet.

### Returns:

an int
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## streamRank

streamRank( ) → int

### Returns:

int
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## toString

toString( ) → String

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc] [view source]