## org.das2.qstream.StreamDescriptor

Description of the Stream, and manages resources for the stream.

## StreamDescriptor( javax.xml.parsers.DocumentBuilderFactory factory )

## addDescriptor

addDescriptor( org.das2.qstream.Descriptor pd ) → void

add the descriptor to the stream, manually assigning it an id

### Parameters

pd - a Descriptor

### Returns:

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

## addDescriptor

addDescriptor( org.das2.qstream.Descriptor pd, int descriptorId ) → void

add the descriptor to the stream, with the given ID.

### Parameters

pd - a Descriptor
descriptorId - an int

### Returns:

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

## descriptorId

descriptorId( org.das2.qstream.Descriptor pd ) → int

get the id for the descriptor. Note packetDescriptors contain the id, but this is not used.

### Parameters

pd - the packet descriptor.

### Returns:

the id
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getByteOrder

getByteOrder( ) → java.nio.ByteOrder

### Returns:

java.nio.ByteOrder
[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]

## hasDescriptor

hasDescriptor( org.das2.qstream.Descriptor pd0, int descriptorId ) → boolean

If a second PacketDescriptor contains the same descriptor information, then the PacketDescriptor can be dropped. This was introduced when two daily streams appended did not create a valid stream. It has the descriptor if: * the number is the same * the planes within are the same ids.

### Parameters

pd0 - a Descriptor
descriptorId - an int

### Returns:

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

## isAsciiTypes

isAsciiTypes( ) → boolean

### Returns:

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

## newDocument

newDocument( org.das2.qstream.Descriptor descriptor ) → org.w3c.dom.Document

get the XML document that will contain the descriptor. Note that a QStream will have many XML documents, one for each descriptor. This keeps track of the documents for each descriptor.

### Parameters

descriptor - the descriptor

### Returns:

the Document, which will have elements added to it.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## retireDescriptor

retireDescriptor( org.das2.qstream.Descriptor pd ) → void

indicate that no more packets will be sent with this descriptor. This will free up the number so it can be reused.

### Parameters

pd - the descriptor.

### Returns:

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

## send

send( org.das2.qstream.Descriptor pd, java.nio.channels.WritableByteChannel out ) → void

### Parameters

pd - a Descriptor
out - a WritableByteChannel

### Returns:

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

## setAsciiTypes

setAsciiTypes( boolean asciiTypes ) → void

### Parameters

asciiTypes - a boolean

### Returns:

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

## setByteOrder

setByteOrder( java.nio.ByteOrder byteOrder ) → void

### Parameters

byteOrder - a ByteOrder

### Returns:

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

## setDomElement

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

### Parameters

element - an Element

### Returns:

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