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 5921546 commit d8ba588
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc-6.0/doxygen/CC/html/de/d9e/_writer_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -297,17 +297,17 @@
<div class="ttc" id="aclassevio_1_1_record_header_html"><div class="ttname"><a href="../../d8/d64/classevio_1_1_record_header.html">evio::RecordHeader</a></div><div class="ttdef"><b>Definition:</b> RecordHeader.h:186</div></div>
<div class="ttc" id="aclassevio_1_1_record_output_html"><div class="ttname"><a href="../../d2/d7a/classevio_1_1_record_output.html">evio::RecordOutput</a></div><div class="ttdoc">Class which handles the creation and use of Evio &amp; HIPO Records.</div><div class="ttdef"><b>Definition:</b> RecordOutput.h:107</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html">evio::Writer</a></div><div class="ttdoc">Class to write Evio-6.0/HIPO files.</div><div class="ttdef"><b>Definition:</b> Writer.h:47</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a0d0f549a6ceaae794eca73130957a23d"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a0d0f549a6ceaae794eca73130957a23d">evio::Writer::writeRecord</a></div><div class="ttdeci">void writeRecord(RecordOutput &amp;record)</div><div class="ttdoc">Appends the record to the file/buffer.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:989</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a0d0f549a6ceaae794eca73130957a23d"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a0d0f549a6ceaae794eca73130957a23d">evio::Writer::writeRecord</a></div><div class="ttdeci">void writeRecord(RecordOutput &amp;record)</div><div class="ttdoc">Appends the record to the file/buffer.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:988</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a17cd4aa42143d1f6578422f6ef36151a"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a17cd4aa42143d1f6578422f6ef36151a">evio::Writer::reset</a></div><div class="ttdeci">void reset()</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a1e500bdfd12a357a6f443def5187b675"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a1e500bdfd12a357a6f443def5187b675">evio::Writer::~Writer</a></div><div class="ttdeci">~Writer()=default</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a1f64043951e4d8ff7f186fced75052fb"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a1f64043951e4d8ff7f186fced75052fb">evio::Writer::open</a></div><div class="ttdeci">void open(const std::string &amp;filename)</div><div class="ttdoc">Open a new file and write file header with no user header.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:469</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a278331c3a1a91c7a7584fea9f4910d5d"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a278331c3a1a91c7a7584fea9f4910d5d">evio::Writer::setCompressionType</a></div><div class="ttdeci">void setCompressionType(Compressor::CompressionType compression)</div><div class="ttdoc">Convenience method that sets compression type for the file.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:387</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a32f50661587a8f13e7729183b2203299"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a32f50661587a8f13e7729183b2203299">evio::Writer::createHeader</a></div><div class="ttdeci">std::shared_ptr&lt; ByteBuffer &gt; createHeader(uint8_t *userHdr, uint32_t userLen)</div><div class="ttdoc">Create and return a buffer containing a general file header followed by the user header given in the ...</div><div class="ttdef"><b>Definition:</b> Writer.cpp:717</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a3f4737e1b27c07329fbb869fbead1f56"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a3f4737e1b27c07329fbb869fbead1f56">evio::Writer::addEvent</a></div><div class="ttdeci">void addEvent(uint8_t *buffer, uint32_t length)</div><div class="ttdoc">Add a byte array to the internal record.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:1050</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a3f4737e1b27c07329fbb869fbead1f56"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a3f4737e1b27c07329fbb869fbead1f56">evio::Writer::addEvent</a></div><div class="ttdeci">void addEvent(uint8_t *buffer, uint32_t length)</div><div class="ttdoc">Add a byte array to the internal record.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:1049</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a4b693782520a223345fcafead7b4b5c0"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a4b693782520a223345fcafead7b4b5c0">evio::Writer::getCompressionType</a></div><div class="ttdeci">Compressor::CompressionType getCompressionType()</div><div class="ttdoc">‍**</div><div class="ttdef"><b>Definition:</b> Writer.cpp:377</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a7584e8ce135dbed869f4e247e371ee75"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a7584e8ce135dbed869f4e247e371ee75">evio::Writer::getBuffer</a></div><div class="ttdeci">std::shared_ptr&lt; ByteBuffer &gt; getBuffer()</div><div class="ttdoc">Get the buffer being written to.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:343</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a8675f4a700a8b0a65fad0c2b7a192940"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a8675f4a700a8b0a65fad0c2b7a192940">evio::Writer::getFileHeader</a></div><div class="ttdeci">FileHeader &amp; getFileHeader()</div><div class="ttdoc">Get the file header.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:357</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a8f01bf28c0d2910947fca9a841a1fc7b"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a8f01bf28c0d2910947fca9a841a1fc7b">evio::Writer::close</a></div><div class="ttdeci">void close()</div><div class="ttdoc">Close opened file.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:1268</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_a8f01bf28c0d2910947fca9a841a1fc7b"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#a8f01bf28c0d2910947fca9a841a1fc7b">evio::Writer::close</a></div><div class="ttdeci">void close()</div><div class="ttdoc">Close opened file.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:1267</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_aa08c22b469bb85b6065876ad2f9482a3"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#aa08c22b469bb85b6065876ad2f9482a3">evio::Writer::getByteOrder</a></div><div class="ttdeci">const ByteOrder &amp; getByteOrder() const</div><div class="ttdoc">Get the file's byte order.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:350</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_ab328948eb2cb9e6297ef750977696073"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#ab328948eb2cb9e6297ef750977696073">evio::Writer::addTrailer</a></div><div class="ttdeci">bool addTrailer() const</div><div class="ttdoc">Does this writer add a trailer to the end of the file/buffer?</div><div class="ttdef"><b>Definition:</b> Writer.cpp:399</div></div>
<div class="ttc" id="aclassevio_1_1_writer_html_acaf968c34f10e8004994a91175e5a829"><div class="ttname"><a href="../../d6/dca/classevio_1_1_writer.html#acaf968c34f10e8004994a91175e5a829">evio::Writer::createRecord</a></div><div class="ttdeci">static std::shared_ptr&lt; ByteBuffer &gt; createRecord(const std::string &amp;dictionary, uint8_t *firstEvent, uint32_t firstEventLen, const ByteOrder &amp;byteOrder, FileHeader *fileHeader, RecordHeader *recordHeader)</div><div class="ttdoc">STATIC.</div><div class="ttdef"><b>Definition:</b> Writer.cpp:653</div></div>
Expand Down

0 comments on commit d8ba588

Please sign in to comment.