<h2>org.das2.qstream.StreamComment</h2><p>StreamComment allows comments to be put onto the stream.
 TODO: consider that comments should be sourced by the stream producer, but what about comments from filters?
   That is, if I'm a filter and I produce comments, should I throw out the comments I receive?</p>
<h2>StreamComment( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> type, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> message )</h2>
<p></p>

<hr>
<a name="TYPE_TASK_PROGRESS"></a>
<h2>TYPE_TASK_PROGRESS</h2>
<p>task progress comments are either of the form:
 
 <pre>
 {@code
   [xx]000000<comment type='taskProgress' message='0 of 100'>   or
   [xx]000000<comment type='taskProgress' message='0 of -1'> for indeterminate
 }
 </pre>

 These are currently unimplemented!</p>

<hr>
<a name="TYPE_LOG"></a>
<h2>TYPE_LOG</h2>
<p>log comments are of the form:
 <pre>
 {@code
   [xx]000000<comment type='log:FINE' message='calc fine process'>   or
   [xx]000000<comment type='log:INFO' message='reading calibration'>
 }
 </pre>
 
 Note the log level should be requested by the client.</p>

<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/StreamComment.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamComment.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/StreamComment.java">[view source]</a>
<br>
<br>
<hr>
<a name="setMessage"></a>
<h2>setMessage</h2>
setMessage( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> message ) &rarr; void

<p></p>

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

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

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

<p></p>

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

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

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