<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: Barry::CodFileBuilder Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1CodFileBuilder.html">CodFileBuilder</a>
</div>
</div>
<div class="contents">
<h1>Barry::CodFileBuilder Class Reference</h1><!-- doxytag: class="Barry::CodFileBuilder" --><code>#include <<a class="el" href="cod_8h-source.html">cod.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for Barry::CodFileBuilder:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1CodFileBuilder__coll__graph.png" border="0" usemap="#Barry_1_1CodFileBuilder__coll__map" alt="Collaboration graph"></center>
<map name="Barry_1_1CodFileBuilder__coll__map">
<area shape="rect" title="STL class." alt="" coords="69,315,149,341"><area shape="rect" title="STL class." alt="" coords="5,237,171,264"><area shape="rect" title="STL class." alt="" coords="195,315,320,341"><area shape="rect" title="STL class." alt="" coords="195,237,408,264"><area shape="rect" title="STL class." alt="" coords="209,160,393,187"><area shape="rect" title="STL class." alt="" coords="225,83,377,109"><area shape="rect" title="STL class." alt="" coords="252,5,351,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classBarry_1_1CodFileBuilder-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classBarry_1_1CodFileBuilder.html" title="The CodFileBuilder class is used to assemble multiple .cod files into a single packed...">CodFileBuilder</a> class is used to assemble multiple .cod files into a single packed .cod file using the pkzip file format.
<p>Definition at line <a class="el" href="cod_8h-source.html#l00056">56</a> of file <a class="el" href="cod_8h-source.html">cod.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1CodFileBuilder.html#22fd9fb2aaed92b0b6ae427a9b90e9ad">WriteNextHeader</a> (std::ostream &output, const uint8_t *buffer, uint32_t module_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes packed .cod file header to the output stream, and appends an entry to the central directory. <a href="#22fd9fb2aaed92b0b6ae427a9b90e9ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1CodFileBuilder.html#5897a4fe8ef826ddf58e045d5b3513ec">WriteFooter</a> (std::ostream &output)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write the central directory and central directory ending indicator to the output stream. <a href="#5897a4fe8ef826ddf58e045d5b3513ec"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="22fd9fb2aaed92b0b6ae427a9b90e9ad"></a><!-- doxytag: member="Barry::CodFileBuilder::WriteNextHeader" ref="22fd9fb2aaed92b0b6ae427a9b90e9ad" args="(std::ostream &output, const uint8_t *buffer, uint32_t module_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Barry::CodFileBuilder::WriteNextHeader </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>module_size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Writes packed .cod file header to the output stream, and appends an entry to the central directory.
<p>
If the module count used to create <a class="el" href="classBarry_1_1CodFileBuilder.html" title="The CodFileBuilder class is used to assemble multiple .cod files into a single packed...">CodFileBuilder</a> is equal to one, the call is ignored.<p>
Note: it is the caller's responsibility to write the actual COD file data after calling this function.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>stream to write to</td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>buffered .cod file data, input to CRC-32 function</td></tr>
<tr><td valign="top"></td><td valign="top"><em>module_size</em> </td><td>total size of .cod file data </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="cod_8cc-source.html#l00118">118</a> of file <a class="el" href="cod_8cc-source.html">cod.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="5897a4fe8ef826ddf58e045d5b3513ec"></a><!-- doxytag: member="Barry::CodFileBuilder::WriteFooter" ref="5897a4fe8ef826ddf58e045d5b3513ec" args="(std::ostream &output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Barry::CodFileBuilder::WriteFooter </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>output</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write the central directory and central directory ending indicator to the output stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>stream to write to </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="cod_8cc-source.html#l00195">195</a> of file <a class="el" href="cod_8cc-source.html">cod.cc</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cod_8h-source.html">cod.h</a><li><a class="el" href="cod_8cc-source.html">cod.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:56 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
