Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@carltimmer
carltimmer committed Dec 16, 2024
1 parent c2b27d3 commit 5921546
Show file tree
Hide file tree
Showing 211 changed files with 335 additions and 413 deletions.
27 changes: 1 addition & 26 deletions doc-6.0/doxygen/CC/html/d1/d17/classevio_1_1_writer_m_t.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,6 @@
<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>
<tr class="memitem:adebafad3524a67dae57ff4a50c991229"><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#adebafad3524a67dae57ff4a50c991229">reset</a> ()</td></tr>
<tr class="memdesc:adebafad3524a67dae57ff4a50c991229"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get this object ready for re-use. <a href="../../d1/d17/classevio_1_1_writer_m_t.html#adebafad3524a67dae57ff4a50c991229">More...</a><br /></td></tr>
<tr class="separator:adebafad3524a67dae57ff4a50c991229"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0647993716e981fbedd6040f80114048"><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#a0647993716e981fbedd6040f80114048">close</a> ()</td></tr>
<tr class="memdesc:a0647993716e981fbedd6040f80114048"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close opened file. <a href="../../d1/d17/classevio_1_1_writer_m_t.html#a0647993716e981fbedd6040f80114048">More...</a><br /></td></tr>
<tr class="separator:a0647993716e981fbedd6040f80114048"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -949,35 +946,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#af882b91785040358120ceded
</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 filename arg is bad, if <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a1f585f15aa1b56884dc8612eb5072e0d" title="Open a new file and write file header with no user header.">open()</a> was already called without being followed by <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#adebafad3524a67dae57ff4a50c991229" title="Get this object ready for re-use.">reset()</a>, if IO error writing to file, if filename is empty, if overwrite is false and file exists. </td></tr>
<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 filename arg is bad, if <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a1f585f15aa1b56884dc8612eb5072e0d" title="Open a new file and write file header with no user header.">open()</a> was already called without being followed by reset(), if IO error writing to file, if filename is empty, if overwrite is false and file exists. </td></tr>
</table>
</dd>
</dl>

<p class="reference">References <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#abe4a6ab09bc138dbd08057262b87d77b">createHeader()</a>, and <a class="el" href="../../d1/da6/classevio_1_1_file_header.html#a01c1f92000c5a0f3b2f11b0c0e5e3a74">evio::FileHeader::getLength()</a>.</p>

</div>
</div>
<a id="adebafad3524a67dae57ff4a50c991229"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adebafad3524a67dae57ff4a50c991229">&#9670;&nbsp;</a></span>reset()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void evio::WriterMT::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Get this object ready for re-use. </p>
<p>Follow calling this with call to <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#a1f585f15aa1b56884dc8612eb5072e0d">open(const std::string &amp;)</a>. </p>

<p class="reference">References <a class="el" href="../../d1/da6/classevio_1_1_file_header.html#af318676a4ffce0023d1bf669bb44cf31">evio::FileHeader::reset()</a>.</p>

</div>
</div>
<a id="a9185ec115b3b04111345b53c7fa64190"></a>
Expand Down
1 change: 0 additions & 1 deletion doc-6.0/doxygen/CC/html/d1/d17/classevio_1_1_writer_m_t.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,5 @@ var classevio_1_1_writer_m_t =
[ "getFileHeader", "d1/d17/classevio_1_1_writer_m_t.html#a68b05c4f9a45ec56f9c5594d513da6d1", null ],
[ "open", "d1/d17/classevio_1_1_writer_m_t.html#a1f585f15aa1b56884dc8612eb5072e0d", null ],
[ "open", "d1/d17/classevio_1_1_writer_m_t.html#af882b91785040358120ceded73921941", null ],
[ "reset", "d1/d17/classevio_1_1_writer_m_t.html#adebafad3524a67dae57ff4a50c991229", null ],
[ "writeRecord", "d1/d17/classevio_1_1_writer_m_t.html#a9185ec115b3b04111345b53c7fa64190", null ]
];
2 changes: 1 addition & 1 deletion doc-6.0/doxygen/CC/html/d1/da6/classevio_1_1_file_header.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1398,7 +1398,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af318676a4ffce0023d1bf669

<p class="reference">References <a class="el" href="../../d1/da6/classevio_1_1_file_header.html#a8af8636060d069a9aa45868710dd7218">HEADER_MAGIC</a>, <a class="el" href="../../d1/da6/classevio_1_1_file_header.html#a60a8eab054b6f02e84d8975e3aa436b9">HEADER_SIZE_BYTES</a>, and <a class="el" href="../../d1/da6/classevio_1_1_file_header.html#ace7c98d335c9ef664cb9e2b4496c8350">HEADER_SIZE_WORDS</a>.</p>

<p class="reference">Referenced by <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a32f50661587a8f13e7729183b2203299">evio::Writer::createHeader()</a>, <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#abe4a6ab09bc138dbd08057262b87d77b">evio::WriterMT::createHeader()</a>, <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a17cd4aa42143d1f6578422f6ef36151a">evio::Writer::reset()</a>, and <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#adebafad3524a67dae57ff4a50c991229">evio::WriterMT::reset()</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a32f50661587a8f13e7729183b2203299">evio::Writer::createHeader()</a>, and <a class="el" href="../../d1/d17/classevio_1_1_writer_m_t.html#abe4a6ab09bc138dbd08057262b87d77b">evio::WriterMT::createHeader()</a>.</p>

</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions doc-6.0/doxygen/CC/html/d2/d7a/classevio_1_1_record_output.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1424,7 +1424,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#abc4221165d1626407280c56e
<p>Reset internal buffers. </p>
<p>The buffer is ready to receive new data. Also resets the header including removing any compression. If data buffer externally provided, the starting position is set to 0. </p>

<p class="reference">References <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#ab6c620b4efec082e1a94e8e32794578d">eventCount</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#ae906482126a5dfdd1cbfcf1ecb93535b">eventSize</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#acd299afe38e9276c82339a3a3a931484">header</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#aa98ea7b099108a9c85b86edf26ac43ba">indexSize</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#aa86ac9bc20793c5731b0faa759f923d3">recordBinary</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a4bc61b0568796ba16c957a0c5e8c4f0f">recordData</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#afa654ece2da736e553092de439b7d235">recordEvents</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#ae24b881792676912fb68bbb7aedeab46">recordIndex</a>, and <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a8b3dde2575a40d0b4e2c56a94b1cb3b4">startingPosition</a>.</p>
<p class="reference">References <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#ab6c620b4efec082e1a94e8e32794578d">eventCount</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#ae906482126a5dfdd1cbfcf1ecb93535b">eventSize</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#acd299afe38e9276c82339a3a3a931484">header</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#aa98ea7b099108a9c85b86edf26ac43ba">indexSize</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#aa86ac9bc20793c5731b0faa759f923d3">recordBinary</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a4bc61b0568796ba16c957a0c5e8c4f0f">recordData</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#afa654ece2da736e553092de439b7d235">recordEvents</a>, and <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#ae24b881792676912fb68bbb7aedeab46">recordIndex</a>.</p>

<p class="reference">Referenced by <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a5430397efd27db0815892cd7c61c08a2">addEvent()</a>, and <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a166f99d57939caf7d61be363ebb8115a">setBuffer()</a>.</p>

Expand Down Expand Up @@ -1815,7 +1815,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8b3dde2575a40d0b4e2c56a9
<p>The starting position of a user-given buffer. </p>
<p>No data will be written before this position. </p>

<p class="reference">Referenced by <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#aa27efc6a41c25b8b88a9114e5ac68e8a">RecordOutput()</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a7c7cbf0f2bcc362662eea1fc4ff5d7ad">build()</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#abc4221165d1626407280c56e7cc4ea70">reset()</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a166f99d57939caf7d61be363ebb8115a">setBuffer()</a>, and <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#acd8fcf62ec243383f68d558a6924c659">setStartingBufferPosition()</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#aa27efc6a41c25b8b88a9114e5ac68e8a">RecordOutput()</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a7c7cbf0f2bcc362662eea1fc4ff5d7ad">build()</a>, <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#a166f99d57939caf7d61be363ebb8115a">setBuffer()</a>, and <a class="el" href="../../d2/d7a/classevio_1_1_record_output.html#acd8fcf62ec243383f68d558a6924c659">setStartingBufferPosition()</a>.</p>

</div>
</div>
Expand Down
10 changes: 2 additions & 8 deletions doc-6.0/doxygen/CC/html/d6/dca/classevio_1_1_writer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,6 @@
<tr class="memdesc:a39d7e291d85d61a6343ac6a40e7902cf"><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="../../d6/dca/classevio_1_1_writer.html#a39d7e291d85d61a6343ac6a40e7902cf">More...</a><br /></td></tr>
<tr class="separator:a39d7e291d85d61a6343ac6a40e7902cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17cd4aa42143d1f6578422f6ef36151a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/dca/classevio_1_1_writer.html#a17cd4aa42143d1f6578422f6ef36151a">reset</a> ()</td></tr>
<tr class="memdesc:a17cd4aa42143d1f6578422f6ef36151a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get this object ready for re-use. <a href="../../d6/dca/classevio_1_1_writer.html#a17cd4aa42143d1f6578422f6ef36151a">More...</a><br /></td></tr>
<tr class="separator:a17cd4aa42143d1f6578422f6ef36151a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f01bf28c0d2910947fca9a841a1fc7b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/dca/classevio_1_1_writer.html#a8f01bf28c0d2910947fca9a841a1fc7b">close</a> ()</td></tr>
<tr class="memdesc:a8f01bf28c0d2910947fca9a841a1fc7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close opened file. <a href="../../d6/dca/classevio_1_1_writer.html#a8f01bf28c0d2910947fca9a841a1fc7b">More...</a><br /></td></tr>
Expand Down Expand Up @@ -1377,7 +1376,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aecf32909431959a361a4db46
</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>filename arg is null, if constructor specified writing to a buffer, if <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a1f64043951e4d8ff7f186fced75052fb" title="Open a new file and write file header with no user header.">open()</a> was already called without being followed by <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a17cd4aa42143d1f6578422f6ef36151a" title="Get this object ready for re-use.">reset()</a>, if IO error writing to file, if filename is empty, or if overwrite is false and file exists. </td></tr>
<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>filename arg is null, if constructor specified writing to a buffer, if <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a1f64043951e4d8ff7f186fced75052fb" title="Open a new file and write file header with no user header.">open()</a> was already called without being followed by <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a17cd4aa42143d1f6578422f6ef36151a">reset()</a>, if IO error writing to file, if filename is empty, or if overwrite is false and file exists. </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -1429,7 +1428,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0c390fc56c957705f1b1a5de
</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 constructor specified writing to a file, or if <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a1f64043951e4d8ff7f186fced75052fb" title="Open a new file and write file header with no user header.">open()</a> was already called without being followed by <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a17cd4aa42143d1f6578422f6ef36151a" title="Get this object ready for re-use.">reset()</a>. </td></tr>
<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 constructor specified writing to a file, or if <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a1f64043951e4d8ff7f186fced75052fb" title="Open a new file and write file header with no user header.">open()</a> was already called without being followed by <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a17cd4aa42143d1f6578422f6ef36151a">reset()</a>. </td></tr>
</table>
</dd>
</dl>
Expand All @@ -1451,11 +1450,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a17cd4aa42143d1f6578422f6
</table>
</div><div class="memdoc">

<p>Get this object ready for re-use. </p>
<p>Follow calling this with call to <a class="el" href="../../d6/dca/classevio_1_1_writer.html#a1f64043951e4d8ff7f186fced75052fb">open(const std::string &amp;)</a>. </p>

<p class="reference">References <a class="el" href="../../d1/da6/classevio_1_1_file_header.html#af318676a4ffce0023d1bf669bb44cf31">evio::FileHeader::reset()</a>.</p>

</div>
</div>
<a id="a278331c3a1a91c7a7584fea9f4910d5d"></a>
Expand Down
Loading

0 comments on commit 5921546

Please sign in to comment.