<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: Barry::CodFileBuilder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<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="annotated.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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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" -->
<p>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.
<a href="#_details">More...</a></p>
<p><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">
<div class="center"><img src="classBarry_1_1CodFileBuilder__coll__graph.png" border="0" usemap="#Barry_1_1CodFileBuilder_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1CodFileBuilder_coll__map" id="Barry_1_1CodFileBuilder_coll__map">
<area shape="rect" id="node2" title="STL class." alt="" coords="69,337,149,367"/><area shape="rect" id="node4" title="STL class." alt="" coords="5,254,173,285"/><area shape="rect" id="node6" title="STL class." alt="" coords="200,337,328,367"/><area shape="rect" id="node8" title="STL class." alt="" coords="197,254,416,285"/><area shape="rect" id="node10" title="STL class." alt="" coords="212,171,401,202"/><area shape="rect" id="node12" title="STL class." alt="" coords="228,89,385,119"/><area shape="rect" id="node14" title="STL class." alt="" coords="256,6,357,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classBarry_1_1CodFileBuilder-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1CodFileBuilder.html#a22fd9fb2aaed92b0b6ae427a9b90e9ad">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="#a22fd9fb2aaed92b0b6ae427a9b90e9ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1CodFileBuilder.html#a5897a4fe8ef826ddf58e045d5b3513ec">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="#a5897a4fe8ef826ddf58e045d5b3513ec"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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>
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5897a4fe8ef826ddf58e045d5b3513ec"></a><!-- doxytag: member="Barry::CodFileBuilder::WriteFooter" ref="a5897a4fe8ef826ddf58e045d5b3513ec" 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><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>
</dd>
</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>
<a class="anchor" id="a22fd9fb2aaed92b0b6ae427a9b90e9ad"></a><!-- doxytag: member="Barry::CodFileBuilder::WriteNextHeader" ref="a22fd9fb2aaed92b0b6ae427a9b90e9ad" 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>
<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>
<p>Note: it is the caller's responsibility to write the actual COD file data after calling this function.</p>
<dl><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>
</dd>
</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>
<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>
<li><a class="el" href="cod_8cc_source.html">cod.cc</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
