<h2>org.das2.qstream.StreamDescriptor</h2><p>Description of the Stream, and manages resources for the stream.</p>
<h2>StreamDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/javax/xml/parsers/DocumentBuilderFactory.html'>javax.xml.parsers.DocumentBuilderFactory</a> factory )</h2>
<p></p>

<hr>
<a name="addDescriptor"></a>
<h2>addDescriptor</h2>
addDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/Descriptor.html'>org.das2.qstream.Descriptor</a> pd ) &rarr; void

<p>add the descriptor to the stream, manually assigning it an id</p>

<h3>Parameters</h3>
pd - a Descriptor

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=addDescriptor&unscoped_q=addDescriptor">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#addDescriptor">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
addDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/Descriptor.html'>org.das2.qstream.Descriptor</a> pd, int descriptorId ) &rarr; void<br>
<hr>
<a name="descriptorId"></a>
<h2>descriptorId</h2>
descriptorId( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/Descriptor.html'>org.das2.qstream.Descriptor</a> pd ) &rarr; int

<p>get the id for the descriptor.  Note packetDescriptors contain the id, 
 but this is not used.</p>

<h3>Parameters</h3>
pd - the packet descriptor.

<h3>Returns:</h3>
the id
<br><br>
<a href="https://github.com/autoplot/dev/search?q=descriptorId&unscoped_q=descriptorId">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#descriptorId">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="getByteOrder"></a>
<h2>getByteOrder</h2>
getByteOrder(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/nio/ByteOrder.html'>java.nio.ByteOrder</a>

<p></p>

<h3>Returns:</h3>
java.nio.ByteOrder

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getByteOrder&unscoped_q=getByteOrder">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#getByteOrder">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="getDomElement"></a>
<h2>getDomElement</h2>
getDomElement(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/w3c/dom/Element.html'>org.w3c.dom.Element</a>

<p></p>

<h3>Returns:</h3>
org.w3c.dom.Element

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getDomElement&unscoped_q=getDomElement">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#getDomElement">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="hasDescriptor"></a>
<h2>hasDescriptor</h2>
hasDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/Descriptor.html'>org.das2.qstream.Descriptor</a> pd0, int descriptorId ) &rarr; boolean

<p>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.</p>

<h3>Parameters</h3>
pd0 - a Descriptor
<br>
descriptorId - an int

<h3>Returns:</h3>
a boolean

<br><br>
<a href="https://github.com/autoplot/dev/search?q=hasDescriptor&unscoped_q=hasDescriptor">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#hasDescriptor">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="isAsciiTypes"></a>
<h2>isAsciiTypes</h2>
isAsciiTypes(  ) &rarr; boolean

<p></p>

<h3>Returns:</h3>
boolean

<br><br>
<a href="https://github.com/autoplot/dev/search?q=isAsciiTypes&unscoped_q=isAsciiTypes">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#isAsciiTypes">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="newDocument"></a>
<h2>newDocument</h2>
newDocument( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/Descriptor.html'>org.das2.qstream.Descriptor</a> descriptor ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/w3c/dom/Document.html'>org.w3c.dom.Document</a>

<p>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.</p>

<h3>Parameters</h3>
descriptor - the descriptor

<h3>Returns:</h3>
the Document, which will have elements added to it.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=newDocument&unscoped_q=newDocument">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#newDocument">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="retireDescriptor"></a>
<h2>retireDescriptor</h2>
retireDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/Descriptor.html'>org.das2.qstream.Descriptor</a> pd ) &rarr; void

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

<h3>Parameters</h3>
pd - the descriptor.

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=retireDescriptor&unscoped_q=retireDescriptor">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#retireDescriptor">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="send"></a>
<h2>send</h2>
send( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/Descriptor.html'>org.das2.qstream.Descriptor</a> pd, <a href='https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html'>java.nio.channels.WritableByteChannel</a> out ) &rarr; void

<p></p>

<h3>Parameters</h3>
pd - a Descriptor
<br>
out - a WritableByteChannel

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=send&unscoped_q=send">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#send">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="setAsciiTypes"></a>
<h2>setAsciiTypes</h2>
setAsciiTypes( boolean asciiTypes ) &rarr; void

<p></p>

<h3>Parameters</h3>
asciiTypes - a boolean

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setAsciiTypes&unscoped_q=setAsciiTypes">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#setAsciiTypes">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="setByteOrder"></a>
<h2>setByteOrder</h2>
setByteOrder( <a href='https://docs.oracle.com/javase/8/docs/api/java/nio/ByteOrder.html'>java.nio.ByteOrder</a> byteOrder ) &rarr; void

<p></p>

<h3>Parameters</h3>
byteOrder - a ByteOrder

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setByteOrder&unscoped_q=setByteOrder">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#setByteOrder">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>
<hr>
<a name="setDomElement"></a>
<h2>setDomElement</h2>
setDomElement( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/w3c/dom/Element.html'>org.w3c.dom.Element</a> element ) &rarr; void

<p></p>

<h3>Parameters</h3>
element - an Element

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=setDomElement&unscoped_q=setDomElement">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamDescriptor.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamDescriptor.html#setDomElement">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamDescriptor.java">[view source]</a>
<br>
<br>