Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
carltimmer committed Dec 16, 2024
1 parent d8ba588 commit 9ac2e1a
Show file tree
Hide file tree
Showing 21 changed files with 249 additions and 131 deletions.
114 changes: 111 additions & 3 deletions doc-6.0/doxygen/CC/html/d1/d17/classevio_1_1_writer_m_t.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,18 @@
<tr class="memitem:a78421457d086cf500d64150da99c6505"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a78421457d086cf500d64150da99c6505">addEvent</a> (uint8_t *buffer, uint32_t offset, uint32_t length)</td></tr>
<tr class="memdesc:a78421457d086cf500d64150da99c6505"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a byte array to the current internal record. <a href="../../d1/d17/classevio_1_1_writer_m_t.html#a78421457d086cf500d64150da99c6505">More...</a><br /></td></tr>
<tr class="separator:a78421457d086cf500d64150da99c6505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaec3cbe7c85ec6709f8856f3f89bfcc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#aeaec3cbe7c85ec6709f8856f3f89bfcc">addEvent</a> (std::shared_ptr&lt; <a class="el" href="../../dc/d30/classevio_1_1_byte_buffer.html">ByteBuffer</a> &gt; buffer)</td></tr>
<tr class="memdesc:aeaec3cbe7c85ec6709f8856f3f89bfcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a <a class="el" href="../../dc/d30/classevio_1_1_byte_buffer.html" title="This class is copied from one of the same name in the Java programming language.">ByteBuffer</a> to the internal record. <a href="../../d1/d17/classevio_1_1_writer_m_t.html#aeaec3cbe7c85ec6709f8856f3f89bfcc">More...</a><br /></td></tr>
<tr class="separator:aeaec3cbe7c85ec6709f8856f3f89bfcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a904111fb56c2dad2141173754827994b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a904111fb56c2dad2141173754827994b">addEvent</a> (<a class="el" href="../../dc/d30/classevio_1_1_byte_buffer.html">ByteBuffer</a> &amp;buffer)</td></tr>
<tr class="memdesc:a904111fb56c2dad2141173754827994b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a <a class="el" href="../../dc/d30/classevio_1_1_byte_buffer.html" title="This class is copied from one of the same name in the Java programming language.">ByteBuffer</a> to the internal record. <a href="../../d1/d17/classevio_1_1_writer_m_t.html#a904111fb56c2dad2141173754827994b">More...</a><br /></td></tr>
<tr class="separator:a904111fb56c2dad2141173754827994b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36b640fc4af8bf0a8d04d2362e604934"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a36b640fc4af8bf0a8d04d2362e604934">addEvent</a> (std::shared_ptr&lt; <a class="el" href="../../de/de3/classevio_1_1_evio_bank.html">EvioBank</a> &gt; bank)</td></tr>
<tr class="memdesc:a36b640fc4af8bf0a8d04d2362e604934"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="../../de/de3/classevio_1_1_evio_bank.html" title="This holds a CODA Bank structure.">EvioBank</a> to the internal record. <a href="../../d1/d17/classevio_1_1_writer_m_t.html#a36b640fc4af8bf0a8d04d2362e604934">More...</a><br /></td></tr>
<tr class="separator:a36b640fc4af8bf0a8d04d2362e604934"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d362e86c93e8413e5eb070d141da458"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a0d362e86c93e8413e5eb070d141da458">addEvent</a> (std::shared_ptr&lt; <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html">EvioNode</a> &gt; node)</td></tr>
<tr class="memdesc:a0d362e86c93e8413e5eb070d141da458"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html" title="This class is used to store relevant info about an evio container (bank, segment, or tag segment),...">EvioNode</a> to the internal record. <a href="../../d1/d17/classevio_1_1_writer_m_t.html#a0d362e86c93e8413e5eb070d141da458">More...</a><br /></td></tr>
<tr class="separator:a0d362e86c93e8413e5eb070d141da458"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a329d5fd7ee27378b2d532e715742bd87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a329d5fd7ee27378b2d532e715742bd87">addEvent</a> (<a class="el" href="../../de/dd0/classevio_1_1_evio_node.html">EvioNode</a> &amp;node)</td></tr>
<tr class="memdesc:a329d5fd7ee27378b2d532e715742bd87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html" title="This class is used to store relevant info about an evio container (bank, segment, or tag segment),...">EvioNode</a> to the internal record. <a href="../../d1/d17/classevio_1_1_writer_m_t.html#a329d5fd7ee27378b2d532e715742bd87">More...</a><br /></td></tr>
<tr class="separator:a329d5fd7ee27378b2d532e715742bd87"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -493,7 +502,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a19e17694d785f9cb315fbb8b
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a904111fb56c2dad2141173754827994b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a904111fb56c2dad2141173754827994b">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[1/3]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a904111fb56c2dad2141173754827994b">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[1/6]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -528,7 +537,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a904111fb56c2dad214117375
</div>
</div>
<a id="a329d5fd7ee27378b2d532e715742bd87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a329d5fd7ee27378b2d532e715742bd87">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[2/3]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a329d5fd7ee27378b2d532e715742bd87">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[2/6]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -560,10 +569,109 @@ <h2 class="memtitle"><span class="permalink"><a href="#a329d5fd7ee27378b2d532e71

<p class="reference">References <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html#a62277033890518669c730a7b41296ec6">evio::EvioNode::getBuffer()</a>.</p>

</div>
</div>
<a id="aeaec3cbe7c85ec6709f8856f3f89bfcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeaec3cbe7c85ec6709f8856f3f89bfcc">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[3/6]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void evio::WriterMT::addEvent </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="../../dc/d30/classevio_1_1_byte_buffer.html">ByteBuffer</a> &gt;&#160;</td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Add a <a class="el" href="../../dc/d30/classevio_1_1_byte_buffer.html" title="This class is copied from one of the same name in the Java programming language.">ByteBuffer</a> to the internal record. </p>
<p>If the length of the buffer exceeds the maximum size of the record, the record will be written to the file (compressed if the flag is set). Internal record will be reset to receive new buffers. Using this method in conjunction with <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a9185ec115b3b04111345b53c7fa64190" title="Appends the record to the file.">writeRecord()</a> is not thread-safe. <b>The byte order of event's data must match the byte order given in constructor!</b></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>buffer to add to the file. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="../../d0/d0b/classevio_1_1_evio_exception.html" title="Exception class for Evio software package.">EvioException</a></td><td>if cannot write to file or buffer arg's byte order is wrong. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a36b640fc4af8bf0a8d04d2362e604934"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36b640fc4af8bf0a8d04d2362e604934">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[4/6]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void evio::WriterMT::addEvent </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="../../de/de3/classevio_1_1_evio_bank.html">EvioBank</a> &gt;&#160;</td>
<td class="paramname"><em>bank</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Add an <a class="el" href="../../de/de3/classevio_1_1_evio_bank.html" title="This holds a CODA Bank structure.">EvioBank</a> to the internal record. </p>
<p>If the length of the bank exceeds the maximum size of the record, the record will be written to the file (compressed if the flag is set). Internal record will be reset to receive new buffers. Using this method in conjunction with <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a9185ec115b3b04111345b53c7fa64190" title="Appends the record to the file.">writeRecord()</a> is not thread-safe.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bank</td><td>event to add to the file. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="../../d0/d0b/classevio_1_1_evio_exception.html" title="Exception class for Evio software package.">EvioException</a></td><td>if cannot write to file. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a0d362e86c93e8413e5eb070d141da458"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d362e86c93e8413e5eb070d141da458">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[5/6]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void evio::WriterMT::addEvent </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html">EvioNode</a> &gt;&#160;</td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Add an <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html" title="This class is used to store relevant info about an evio container (bank, segment, or tag segment),...">EvioNode</a> to the internal record. </p>
<p>If the length of the data exceeds the maximum size of the record, the record will be written to the file (compressed if the flag is set). Internal record will be reset to receive new buffers. Using this method in conjunction with <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a9185ec115b3b04111345b53c7fa64190" title="Appends the record to the file.">writeRecord()</a> is not thread-safe. <b>The byte order of node's data must match the byte order given in constructor!</b></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>node to add to the file. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="../../d0/d0b/classevio_1_1_evio_exception.html" title="Exception class for Evio software package.">EvioException</a></td><td>if cannot write to file or node arg's byte order is wrong. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a78421457d086cf500d64150da99c6505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78421457d086cf500d64150da99c6505">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[3/3]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a78421457d086cf500d64150da99c6505">&#9670;&nbsp;</a></span>addEvent() <span class="overload">[6/6]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down
3 changes: 3 additions & 0 deletions doc-6.0/doxygen/CC/html/d1/d17/classevio_1_1_writer_m_t.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ var classevio_1_1_writer_m_t =
[ "~WriterMT", "d1/d17/classevio_1_1_writer_m_t.html#a19e17694d785f9cb315fbb8bb45dd98e", null ],
[ "addEvent", "d1/d17/classevio_1_1_writer_m_t.html#a904111fb56c2dad2141173754827994b", null ],
[ "addEvent", "d1/d17/classevio_1_1_writer_m_t.html#a329d5fd7ee27378b2d532e715742bd87", null ],
[ "addEvent", "d1/d17/classevio_1_1_writer_m_t.html#aeaec3cbe7c85ec6709f8856f3f89bfcc", null ],
[ "addEvent", "d1/d17/classevio_1_1_writer_m_t.html#a36b640fc4af8bf0a8d04d2362e604934", null ],
[ "addEvent", "d1/d17/classevio_1_1_writer_m_t.html#a0d362e86c93e8413e5eb070d141da458", null ],
[ "addEvent", "d1/d17/classevio_1_1_writer_m_t.html#a78421457d086cf500d64150da99c6505", null ],
[ "addTrailer", "d1/d17/classevio_1_1_writer_m_t.html#a602ade27297bb163f4c85452d7b3d0ec", null ],
[ "addTrailer", "d1/d17/classevio_1_1_writer_m_t.html#af9f6fb10f2b791d56a2a86356e404b25", null ],
Expand Down
Loading

0 comments on commit 9ac2e1a

Please sign in to comment.