doc/www/doxygen/html/classBarry_1_1CodFileBuilder.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: Barry::CodFileBuilder Class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  15       <li><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="tabs">
  20     <ul>
  21       <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
  22       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  23       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25     </ul>
  26   </div>
  27   <div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1CodFileBuilder.html">CodFileBuilder</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>Barry::CodFileBuilder Class Reference</h1><!-- doxytag: class="Barry::CodFileBuilder" --><code>#include &lt;<a class="el" href="cod_8h-source.html">cod.h</a>&gt;</code>
  32 <p>
  33 <div class="dynheader">
  34 Collaboration diagram for Barry::CodFileBuilder:</div>
  35 <div class="dynsection">
  36 <p><center><img src="classBarry_1_1CodFileBuilder__coll__graph.png" border="0" usemap="#Barry_1_1CodFileBuilder__coll__map" alt="Collaboration graph"></center>
  37 <map name="Barry_1_1CodFileBuilder__coll__map">
  38 <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>
  39 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  40
  41 <p>
  42 <a href="classBarry_1_1CodFileBuilder-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  43 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.
  44 <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>
  45 <table border="0" cellpadding="0" cellspacing="0">
  46 <tr><td></td></tr>
  47 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1CodFileBuilder.html#22fd9fb2aaed92b0b6ae427a9b90e9ad">WriteNextHeader</a> (std::ostream &amp;output, const uint8_t *buffer, uint32_t module_size)</td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</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>
  51 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1CodFileBuilder.html#5897a4fe8ef826ddf58e045d5b3513ec">WriteFooter</a> (std::ostream &amp;output)</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write the central directory and central directory ending indicator to the output stream.  <a href="#5897a4fe8ef826ddf58e045d5b3513ec"></a><br></td></tr>
  54 </table>
  55 <hr><h2>Member Function Documentation</h2>
  56 <a class="anchor" name="22fd9fb2aaed92b0b6ae427a9b90e9ad"></a><!-- doxytag: member="Barry::CodFileBuilder::WriteNextHeader" ref="22fd9fb2aaed92b0b6ae427a9b90e9ad" args="(std::ostream &amp;output, const uint8_t *buffer, uint32_t module_size)" -->
  57 <div class="memitem">
  58 <div class="memproto">
  59       <table class="memname">
  60         <tr>
  61           <td class="memname">void Barry::CodFileBuilder::WriteNextHeader           </td>
  62           <td>(</td>
  63           <td class="paramtype">std::ostream &amp;&nbsp;</td>
  64           <td class="paramname"> <em>output</em>, </td>
  65         </tr>
  66         <tr>
  67           <td class="paramkey"></td>
  68           <td></td>
  69           <td class="paramtype">const uint8_t *&nbsp;</td>
  70           <td class="paramname"> <em>buffer</em>, </td>
  71         </tr>
  72         <tr>
  73           <td class="paramkey"></td>
  74           <td></td>
  75           <td class="paramtype">uint32_t&nbsp;</td>
  76           <td class="paramname"> <em>module_size</em></td><td>&nbsp;</td>
  77         </tr>
  78         <tr>
  79           <td></td>
  80           <td>)</td>
  81           <td></td><td></td><td></td>
  82         </tr>
  83       </table>
  84 </div>
  85 <div class="memdoc">
  86
  87 <p>
  88 Writes packed .cod file header to the output stream, and appends an entry to the central directory.
  89 <p>
  90 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>
  91 Note: it is the caller's responsibility to write the actual COD file data after calling this function.<p>
  92 <dl compact><dt><b>Parameters:</b></dt><dd>
  93   <table border="0" cellspacing="2" cellpadding="0">
  94     <tr><td valign="top"></td><td valign="top"><em>output</em>&nbsp;</td><td>stream to write to</td></tr>
  95     <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>buffered .cod file data, input to CRC-32 function</td></tr>
  96     <tr><td valign="top"></td><td valign="top"><em>module_size</em>&nbsp;</td><td>total size of .cod file data </td></tr>
  97   </table>
  98 </dl>
  99
 100 <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>
 101
 102 </div>
 103 </div><p>
 104 <a class="anchor" name="5897a4fe8ef826ddf58e045d5b3513ec"></a><!-- doxytag: member="Barry::CodFileBuilder::WriteFooter" ref="5897a4fe8ef826ddf58e045d5b3513ec" args="(std::ostream &amp;output)" -->
 105 <div class="memitem">
 106 <div class="memproto">
 107       <table class="memname">
 108         <tr>
 109           <td class="memname">void Barry::CodFileBuilder::WriteFooter           </td>
 110           <td>(</td>
 111           <td class="paramtype">std::ostream &amp;&nbsp;</td>
 112           <td class="paramname"> <em>output</em>          </td>
 113           <td>&nbsp;)&nbsp;</td>
 114           <td></td>
 115         </tr>
 116       </table>
 117 </div>
 118 <div class="memdoc">
 119
 120 <p>
 121 Write the central directory and central directory ending indicator to the output stream.
 122 <p>
 123 <dl compact><dt><b>Parameters:</b></dt><dd>
 124   <table border="0" cellspacing="2" cellpadding="0">
 125     <tr><td valign="top"></td><td valign="top"><em>output</em>&nbsp;</td><td>stream to write to </td></tr>
 126   </table>
 127 </dl>
 128
 129 <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>
 130
 131 </div>
 132 </div><p>
 133 <hr>The documentation for this class was generated from the following files:<ul>
 134 <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>
 135 </div>
 136 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:36 2011 for Barry by&nbsp;
 137 <a href="http://www.doxygen.org/index.html">
 138 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 139 </body>
 140 </html>