<h2>org.das2.qstream.SerialStreamFormatter</h2><p>We need a class that can format a stream serially.  SimpleStreamFormatter needs the whole dataset, which really
 misses the point with QStreams, that you can process and create data streams serially on the server side.  The
 das2stream codes were first coded with this use case, but QStreams were not and because of this a good serial
 generator was never created.

 See the main method for an example of how this is used.

 Note this class is not thread-safe and assumes that only one thread will be working on the stream.  This may change.</p>
<h2>SerialStreamFormatter( )</h2>
<p></p>

<hr>
<a name="DEFAULT_TIME_DIGITS"></a>
<h2>DEFAULT_TIME_DIGITS</h2>
<p></p>

<hr>
<a name="INOUTFORM_INLINE"></a>
<h2>INOUTFORM_INLINE</h2>
<p></p>

<hr>
<a name="INOUTFORM_ONE_RECORD"></a>
<h2>INOUTFORM_ONE_RECORD</h2>
<p></p>

<hr>
<a name="INOUTFORM_STREAMING"></a>
<h2>INOUTFORM_STREAMING</h2>
<p></p>

<hr>
<a name="format"></a>
<h2>format</h2>
format( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> joinName, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/QDataSet.html'>QDataSet</a> ds1, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> inoutForm ) &rarr; void

<p>format the dataset, maybe sending a descriptor if it hasn't been sent already.</p>

<h3>Parameters</h3>
joinName - the name to which we join the dataset.
<br>
name - the name for the dataset of which ds1 is all or a slice of, or null.
<br>
ds1 - a QDataSet
<br>
inoutForm - one of "inline", "oneRecord", or "streaming"

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

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

<p>the name of the default dataset.</p>

<h3>Parameters</h3>
name - a String
<br>
out - a WritableByteChannel

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

<br><br>
<a href="https://github.com/autoplot/dev/search?q=init&unscoped_q=init">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/SerialStreamFormatter.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/SerialStreamFormatter.html#init">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/SerialStreamFormatter.java">[view source]</a>
<br>
<br>
init( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamHandler.html'>org.das2.qstream.StreamHandler</a> sh ) &rarr; void<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/SerialStreamFormatter.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/SerialStreamFormatter.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/SerialStreamFormatter.java">[view source]</a>
<br>
<br>
<hr>
<a name="isBigEndian"></a>
<h2>isBigEndian</h2>
isBigEndian(  ) &rarr; boolean

<p></p>

<h3>Returns:</h3>
boolean

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

<p></p>

<h3>Parameters</h3>
name - a String
<br>
rank - an int
<br>
props - a java.util.Map

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

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

<p></p>

<h3>Parameters</h3>
args - a java.lang.String[]

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

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

<p>format the dataset, maybe sending a descriptor if it hasn't been sent already.
 ds1 may be null in this function, in which case nothing needs to be done.</p>

<h3>Parameters</h3>
name - the name for the dataset of which ds1 is all or a slice of, or null.
<br>
ds1 - a QDataSet
<br>
inoutForm - a String

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

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

<p>allow the stream to recycle the name.  new packets with this name will issue a new packetDescriptor.</p>

<h3>Parameters</h3>
name - a String

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

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

<p></p>

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

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

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

<p>explicitly set the transfer type.</p>

<h3>Parameters</h3>
name - a String
<br>
tt - a TransferType

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

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

<p>explicitly set the transfer type used to transfer data that is convertible to this
 unit.</p>

<h3>Parameters</h3>
u - an Units
<br>
tt - a TransferType

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

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