Update docs

JeffersonLab · Nov 13, 2024 · a8fa407 · a8fa407
1 parent 2fff2d9
commit a8fa407
Show file tree

Hide file tree

Showing 3 changed files with 386 additions and 350 deletions.
diff --git a/doc-6.0/javadoc/index-all.html b/doc-6.0/javadoc/index-all.html
@@ -93,6 +93,10 @@ <h2 class="title">A</h2>
 <dd>
 <div class="block">Add an array of 8 bit bytes (chars) to the data.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="org/jlab/coda/jevio/CompactEventBuilder.html#addCharData-byte:A-">addCharData(byte[])</a></span> - Method in class org.jlab.coda.jevio.<a href="org/jlab/coda/jevio/CompactEventBuilder.html" title="class in org.jlab.coda.jevio">CompactEventBuilder</a></dt>
+<dd>
+<div class="block">Appends byte data to the structure.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="org/jlab/coda/jevio/EventBuilder.html#addChild-org.jlab.coda.jevio.BaseStructure-org.jlab.coda.jevio.BaseStructure-">addChild(BaseStructure, BaseStructure)</a></span> - Method in class org.jlab.coda.jevio.<a href="org/jlab/coda/jevio/EventBuilder.html" title="class in org.jlab.coda.jevio">EventBuilder</a></dt>
 <dd>
 <div class="block">Add a child to a parent structure.</div>

diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/CompactEventBuilder.html b/doc-6.0/javadoc/org/jlab/coda/jevio/CompactEventBuilder.html
@@ -21,7 +21,7 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -198,165 +198,171 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addCharData-byte:A-">addCharData</a></span>(byte[]&nbsp;data)</code>
+<div class="block">Appends byte data to the structure.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addCompositeData-org.jlab.coda.jevio.CompositeData:A-">addCompositeData</a></span>(<a href="../../../../org/jlab/coda/jevio/CompositeData.html" title="class in org.jlab.coda.jevio">CompositeData</a>[]&nbsp;data)</code>
 <div class="block">Appends CompositeData objects to the structure.</div>
 </td>
 </tr>
-<tr id="i2" class="altColor">
+<tr id="i3" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addDoubleData-double:A-">addDoubleData</a></span>(double[]&nbsp;data)</code>
 <div class="block">Appends double data to the structure.</div>
 </td>
 </tr>
-<tr id="i3" class="rowColor">
+<tr id="i4" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addEvioNode-org.jlab.coda.jevio.EvioNode-">addEvioNode</a></span>(<a href="../../../../org/jlab/coda/jevio/EvioNode.html" title="class in org.jlab.coda.jevio">EvioNode</a>&nbsp;node)</code>
 <div class="block">Adds the evio structure represented by the EvioNode object
  into the buffer.</div>
 </td>
 </tr>
-<tr id="i4" class="altColor">
+<tr id="i5" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addFloatData-float:A-">addFloatData</a></span>(float[]&nbsp;data)</code>
 <div class="block">Appends float data to the structure.</div>
 </td>
 </tr>
-<tr id="i5" class="rowColor">
+<tr id="i6" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addIntData-int:A-">addIntData</a></span>(int[]&nbsp;data)</code>
 <div class="block">Appends int data to the structure.</div>
 </td>
 </tr>
-<tr id="i6" class="altColor">
+<tr id="i7" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addIntData-int:A-int-">addIntData</a></span>(int[]&nbsp;data,
           int&nbsp;offset)</code>
 <div class="block">Appends int data to the structure.</div>
 </td>
 </tr>
-<tr id="i7" class="rowColor">
+<tr id="i8" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addIntData-int:A-int-int-">addIntData</a></span>(int[]&nbsp;data,
           int&nbsp;offset,
           int&nbsp;len)</code>
 <div class="block">Appends int data to the structure.</div>
 </td>
 </tr>
-<tr id="i8" class="altColor">
+<tr id="i9" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addLongData-long:A-">addLongData</a></span>(long[]&nbsp;data)</code>
 <div class="block">Appends long data to the structure.</div>
 </td>
 </tr>
-<tr id="i9" class="rowColor">
+<tr id="i10" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addLongData-long:A-int-int-">addLongData</a></span>(long[]&nbsp;data,
            int&nbsp;offset,
            int&nbsp;len)</code>
 <div class="block">Appends long data to the structure.</div>
 </td>
 </tr>
-<tr id="i10" class="altColor">
+<tr id="i11" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addShortData-short-">addShortData</a></span>(short&nbsp;data)</code>
 <div class="block">Appends a short integer to the structure.</div>
 </td>
 </tr>
-<tr id="i11" class="rowColor">
+<tr id="i12" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addShortData-short:A-">addShortData</a></span>(short[]&nbsp;data)</code>
 <div class="block">Appends short data to the structure.</div>
 </td>
 </tr>
-<tr id="i12" class="altColor">
+<tr id="i13" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addShortData-short:A-int-int-">addShortData</a></span>(short[]&nbsp;data,
             int&nbsp;offset,
             int&nbsp;len)</code>
 <div class="block">Appends short data to the structure.</div>
 </td>
 </tr>
-<tr id="i13" class="rowColor">
+<tr id="i14" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#addStringData-java.lang.String:A-">addStringData</a></span>(java.lang.String[]&nbsp;strings)</code>
 <div class="block">Appends string array to the structure.</div>
 </td>
 </tr>
-<tr id="i14" class="altColor">
+<tr id="i15" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#closeAll--">closeAll</a></span>()</code>
 <div class="block">This method finishes the event writing by setting all the
  proper lengths &amp; padding and ends up at the event or top level.</div>
 </td>
 </tr>
-<tr id="i15" class="rowColor">
+<tr id="i16" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#closeStructure--">closeStructure</a></span>()</code>
 <div class="block">This method ends the writing of the current evio structure and
  makes sure the length and padding fields are properly set.</div>
 </td>
 </tr>
-<tr id="i16" class="altColor">
+<tr id="i17" class="rowColor">
 <td class="colFirst"><code>java.nio.ByteBuffer</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#getBuffer--">getBuffer</a></span>()</code>
 <div class="block">Get the buffer being written into.</div>
 </td>
 </tr>
-<tr id="i17" class="rowColor">
+<tr id="i18" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#getTotalBytes--">getTotalBytes</a></span>()</code>
 <div class="block">Get the total number of bytes written into the buffer.</div>
 </td>
 </tr>
-<tr id="i18" class="altColor">
+<tr id="i19" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/jlab/coda/jevio/EvioNode.html" title="class in org.jlab.coda.jevio">EvioNode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#openBank-int-int-org.jlab.coda.jevio.DataType-">openBank</a></span>(int&nbsp;tag,
         int&nbsp;num,
         <a href="../../../../org/jlab/coda/jevio/DataType.html" title="enum in org.jlab.coda.jevio">DataType</a>&nbsp;dataType)</code>
 <div class="block">This method adds an evio bank to the buffer.</div>
 </td>
 </tr>
-<tr id="i19" class="rowColor">
+<tr id="i20" class="altColor">
 <td class="colFirst"><code><a href="../../../../org/jlab/coda/jevio/EvioNode.html" title="class in org.jlab.coda.jevio">EvioNode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#openSegment-int-org.jlab.coda.jevio.DataType-">openSegment</a></span>(int&nbsp;tag,
            <a href="../../../../org/jlab/coda/jevio/DataType.html" title="enum in org.jlab.coda.jevio">DataType</a>&nbsp;dataType)</code>
 <div class="block">This method adds an evio segment structure to the buffer.</div>
 </td>
 </tr>
-<tr id="i20" class="altColor">
+<tr id="i21" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/jlab/coda/jevio/EvioNode.html" title="class in org.jlab.coda.jevio">EvioNode</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#openTagSegment-int-org.jlab.coda.jevio.DataType-">openTagSegment</a></span>(int&nbsp;tag,
               <a href="../../../../org/jlab/coda/jevio/DataType.html" title="enum in org.jlab.coda.jevio">DataType</a>&nbsp;dataType)</code>
 <div class="block">This method adds an evio tagsegment structure to the buffer.</div>
 </td>
 </tr>
-<tr id="i21" class="rowColor">
+<tr id="i22" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#reset--">reset</a></span>()</code>
 <div class="block">Reset all members for reuse of this object.</div>
 </td>
 </tr>
-<tr id="i22" class="altColor">
+<tr id="i23" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#setBuffer-java.nio.ByteBuffer-">setBuffer</a></span>(java.nio.ByteBuffer&nbsp;buffer)</code>
 <div class="block">Set the buffer to be written into.</div>
 </td>
 </tr>
-<tr id="i23" class="rowColor">
+<tr id="i24" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#setBuffer-java.nio.ByteBuffer-boolean-">setBuffer</a></span>(java.nio.ByteBuffer&nbsp;buffer,
          boolean&nbsp;generateNodes)</code>
 <div class="block">Set the buffer to be written into.</div>
 </td>
 </tr>
-<tr id="i24" class="altColor">
+<tr id="i25" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#setTopLevelTag-short-">setTopLevelTag</a></span>(short&nbsp;tag)</code>
 <div class="block">In the emu software package, it's necessary to change the top level
  tag after the top level bank has already been created.</div>
 </td>
 </tr>
-<tr id="i25" class="rowColor">
+<tr id="i26" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/CompactEventBuilder.html#toFile-java.lang.String-">toFile</a></span>(java.lang.String&nbsp;filename)</code>
 <div class="block">This method writes a file in proper evio format with block header
@@ -729,6 +735,26 @@ <h4>addByteData</h4>
 </dl>
 </li>
 </ul>
+<a name="addCharData-byte:A-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addCharData</h4>
+<pre>public&nbsp;void&nbsp;addCharData(byte[]&nbsp;data)
+                 throws <a href="../../../../org/jlab/coda/jevio/EvioException.html" title="class in org.jlab.coda.jevio">EvioException</a></pre>
+<div class="block">Appends byte data to the structure.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>data</code> - the byte data to append.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/jlab/coda/jevio/EvioException.html" title="class in org.jlab.coda.jevio">EvioException</a></code> - if data is null or empty;
+                       if adding wrong data type to structure;
+                       if structure not added first;
+                       if no room in buffer for data.</dd>
+</dl>
+</li>
+</ul>
 <a name="addIntData-int:A-">
 <!--   -->
 </a>