org.das2.qstream.StreamDescriptor

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

addDescriptor

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

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

Parameters

pd -

Returns:

void (returns nothing)

search for examples view on GitHub 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 source

getByteOrder

getByteOrder( ) → ByteOrder

Returns:

java.nio.ByteOrder

search for examples view on GitHub 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 -
descriptorId -

Returns:

boolean

search for examples view on GitHub view source

newDocument

newDocument( org.das2.qstream.Descriptor descriptor ) → 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 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 source

setByteOrder

setByteOrder( java.nio.ByteOrder byteOrder ) → void

Returns:

void (returns nothing)

search for examples view on GitHub view source

setDomElement

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

Returns:

void (returns nothing)

search for examples view on GitHub view source