<!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::BoostBuilder 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_1BoostBuilder.html">BoostBuilder</a>
</div>
</div>
<div class="contents">
<h1>Barry::BoostBuilder Class Reference</h1><!-- doxytag: class="Barry::BoostBuilder" --><!-- doxytag: inherits="Barry::Builder" --><code>#include <<a class="el" href="s11n-boost_8h-source.html">s11n-boost.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for Barry::BoostBuilder:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1BoostBuilder__inherit__graph.png" border="0" usemap="#Barry_1_1BoostBuilder__inherit__map" alt="Inheritance graph"></center>
<map name="Barry_1_1BoostBuilder__inherit__map">
<area shape="rect" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy." alt="" coords="23,5,121,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for Barry::BoostBuilder:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1BoostBuilder__coll__graph.png" border="0" usemap="#Barry_1_1BoostBuilder__coll__map" alt="Collaboration graph"></center>
<map name="Barry_1_1BoostBuilder__coll__map">
<area shape="rect" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy." alt="" coords="5,363,104,389"><area shape="rect" title="STL class." alt="" coords="103,312,193,339"><area shape="rect" title="STL class." alt="" coords="45,211,221,237"><area shape="rect" title="STL class." alt="" coords="73,83,225,109"><area shape="rect" title="STL class." alt="" coords="171,160,349,187"><area shape="rect" title="STL class." alt="" coords="100,5,199,32"><area shape="rect" title="STL class." alt="" coords="205,363,299,389"><area shape="rect" title="STL class." alt="" coords="171,261,352,288"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classBarry_1_1BoostBuilder-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
This <a class="el" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> class reads a boost serialization stream, and converts them into <a class="el" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> records.
<p>
Can only produce records for record types in ALL_KNOWN_BUILDER_TYPES.
<p>Definition at line <a class="el" href="s11n-boost_8h-source.html#l00666">666</a> of file <a class="el" href="s11n-boost_8h-source.html">s11n-boost.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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1BoostBuilder.html#0473eb8b060317ad42792283154564fe">BuildRecord</a> (<a class="el" href="classBarry_1_1DBData.html">DBData</a> &data, size_t &offset, const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *ic)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to build the record field data. <a href="#0473eb8b060317ad42792283154564fe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1BoostBuilder.html#414b487b41d7c84015ae2c7d32a200ad">FetchRecord</a> (<a class="el" href="classBarry_1_1DBData.html">DBData</a> &data, const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *ic)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Same as BuildRecord, but does not care about any offsets. <a href="#414b487b41d7c84015ae2c7d32a200ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1BoostBuilder.html#499467f5c4474fa91c90d0701e3bb0e0">EndOfFile</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sometimes a builder can have multiple databases stored in it, so when Build/Fetch returns false, check if there is more data with this function. <a href="#499467f5c4474fa91c90d0701e3bb0e0"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0473eb8b060317ad42792283154564fe"></a><!-- doxytag: member="Barry::BoostBuilder::BuildRecord" ref="0473eb8b060317ad42792283154564fe" args="(DBData &data, size_t &offset, const IConverter *ic)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Barry::BoostBuilder::BuildRecord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBarry_1_1DBData.html">DBData</a> & </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t & </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> * </td>
<td class="paramname"> <em>ic</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called to build the record field data.
<p>
Store the raw data in data, using offset to know where to write. Be sure to update offset, and be sure to adjust the size of the data packet (possibly with Data::ReleaseBuffer()).<p>
Returns true if successful, and false if at the end of the series. Note that if <a class="el" href="classBarry_1_1BoostBuilder.html#499467f5c4474fa91c90d0701e3bb0e0" title="Sometimes a builder can have multiple databases stored in it, so when Build/Fetch...">EndOfFile()</a> is false after this function returns false, then there may be another series available, which the next call to <a class="el" href="classBarry_1_1BoostBuilder.html#0473eb8b060317ad42792283154564fe" title="Called to build the record field data.">BuildRecord()</a> will determine.
<p>Implements <a class="el" href="classBarry_1_1Builder.html#4a3d38061d957eb6dd0539b18d40e6ad">Barry::Builder</a>.</p>
<p>Definition at line <a class="el" href="s11n-boost_8h-source.html#l00718">718</a> of file <a class="el" href="s11n-boost_8h-source.html">s11n-boost.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="414b487b41d7c84015ae2c7d32a200ad"></a><!-- doxytag: member="Barry::BoostBuilder::FetchRecord" ref="414b487b41d7c84015ae2c7d32a200ad" args="(DBData &data, const IConverter *ic)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Barry::BoostBuilder::FetchRecord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBarry_1_1DBData.html">DBData</a> & </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> * </td>
<td class="paramname"> <em>ic</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Same as BuildRecord, but does not care about any offsets.
<p>
The caller should call DBData::GetOffset() afterward to discover if there is an offset to the result.<p>
This is usually the fastest of the two functions, since extra copying may be required if a specific offset is given. When building records from Record classes, both functions are the same speed. But when building records from the device, the device decides the offset, so <a class="el" href="classBarry_1_1BoostBuilder.html#414b487b41d7c84015ae2c7d32a200ad" title="Same as BuildRecord, but does not care about any offsets.">FetchRecord()</a> is faster, since BuildRecord requires a copy to adjust to the right offset.<p>
The caller should use the function that results in the least amount of copying for the caller. If the caller doesn't care about where the resulting record is in data, use <a class="el" href="classBarry_1_1BoostBuilder.html#414b487b41d7c84015ae2c7d32a200ad" title="Same as BuildRecord, but does not care about any offsets.">FetchRecord()</a>.
<p>Implements <a class="el" href="classBarry_1_1Builder.html#005a0269c1f96947d7a75c1cc09a4609">Barry::Builder</a>.</p>
<p>Definition at line <a class="el" href="s11n-boost_8h-source.html#l00729">729</a> of file <a class="el" href="s11n-boost_8h-source.html">s11n-boost.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="499467f5c4474fa91c90d0701e3bb0e0"></a><!-- doxytag: member="Barry::BoostBuilder::EndOfFile" ref="499467f5c4474fa91c90d0701e3bb0e0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Barry::BoostBuilder::EndOfFile </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sometimes a builder can have multiple databases stored in it, so when Build/Fetch returns false, check if there is more data with this function.
<p>
This function is not used by database-oriented functions, but by pipe- oriented functions.
<p>Implements <a class="el" href="classBarry_1_1Builder.html#0ecfa5788ddee814a2071c82c5734691">Barry::Builder</a>.</p>
<p>Definition at line <a class="el" href="s11n-boost_8h-source.html#l00740">740</a> of file <a class="el" href="s11n-boost_8h-source.html">s11n-boost.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="s11n-boost_8h-source.html">s11n-boost.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:51:04 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>
