<!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::Pipe 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_1Pipe.html">Pipe</a>
</div>
</div>
<div class="contents">
<h1>Barry::Pipe Class Reference</h1><!-- doxytag: class="Barry::Pipe" --><code>#include <<a class="el" href="pipe_8h-source.html">pipe.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for Barry::Pipe:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1Pipe__coll__graph.png" border="0" usemap="#Barry_1_1Pipe__coll__map" alt="Collaboration graph"></center>
<map name="Barry_1_1Pipe__coll__map">
<area shape="rect" href="classBarry_1_1DBData.html" title="Database record data class." alt="" coords="48,189,152,216"><area shape="rect" title="STL class." alt="" coords="117,83,197,109"><area shape="rect" title="STL class." alt="" coords="75,5,240,32"><area shape="rect" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy." alt="" coords="176,189,275,216"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classBarry_1_1Pipe-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Reads data from a builder and feeds it into a parser.
<p>Definition at line <a class="el" href="pipe_8h-source.html#l00036">36</a> of file <a class="el" href="pipe_8h-source.html">pipe.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">const <a class="el" href="classBarry_1_1Builder.html">Builder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Pipe.html#5a63c9f84ccb3a580b2ba81ba690bd87">GetBuilder</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access the builder. <a href="#5a63c9f84ccb3a580b2ba81ba690bd87"></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_1Pipe.html#c37ea1a469fdc249eba6fb65e421cf34">PumpEntry</a> (<a class="el" href="classBarry_1_1Parser.html">Parser</a> &parser, const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *ic=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads one item from the builder and feeds it into the parser and returns the builder Retrieve status. <a href="#c37ea1a469fdc249eba6fb65e421cf34"></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_1Pipe.html#6ac2aa700bf3aa575dec422b45d1b40f">PumpSeries</a> (<a class="el" href="classBarry_1_1Parser.html">Parser</a> &parser, const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *ic=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads all items from builder, feeding them into the parser, until the builder's Retrieve() signals the end of the series. <a href="#6ac2aa700bf3aa575dec422b45d1b40f"></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_1Pipe.html#0978edd4b1a8a0dcab3b6dd49b5a71ba">PumpFile</a> (<a class="el" href="classBarry_1_1Parser.html">Parser</a> &parser, const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *ic=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads all series from the builder, feeding them into the parser, until the builder's EndOfFile() is true. <a href="#0978edd4b1a8a0dcab3b6dd49b5a71ba"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5a63c9f84ccb3a580b2ba81ba690bd87"></a><!-- doxytag: member="Barry::Pipe::GetBuilder" ref="5a63c9f84ccb3a580b2ba81ba690bd87" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classBarry_1_1Builder.html">Builder</a>& Barry::Pipe::GetBuilder </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Access the builder.
<p>
.. mostly useful for finding out the database name for the next series, if using multiple parser objects.
<p>Definition at line <a class="el" href="pipe_8h-source.html#l00049">49</a> of file <a class="el" href="pipe_8h-source.html">pipe.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c37ea1a469fdc249eba6fb65e421cf34"></a><!-- doxytag: member="Barry::Pipe::PumpEntry" ref="c37ea1a469fdc249eba6fb65e421cf34" args="(Parser &parser, const IConverter *ic=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Barry::Pipe::PumpEntry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBarry_1_1Parser.html">Parser</a> & </td>
<td class="paramname"> <em>parser</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> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads one item from the builder and feeds it into the parser and returns the builder Retrieve status.
<p>
<p>Definition at line <a class="el" href="pipe_8cc-source.html#l00035">35</a> of file <a class="el" href="pipe_8cc-source.html">pipe.cc</a>.</p>
<p>References <a class="el" href="classBarry_1_1Builder.html#005a0269c1f96947d7a75c1cc09a4609">Barry::Builder::FetchRecord()</a>, and <a class="el" href="classBarry_1_1Parser.html#1d8325c74140cda51c5735c6f82b7511">Barry::Parser::ParseRecord()</a>.</p>
<p>Referenced by <a class="el" href="pipe_8cc-source.html#l00048">PumpSeries()</a>.</p>
<p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1Pipe_c37ea1a469fdc249eba6fb65e421cf34_cgraph.png" border="0" usemap="#classBarry_1_1Pipe_c37ea1a469fdc249eba6fb65e421cf34_cgraph_map" alt=""></center>
<map name="classBarry_1_1Pipe_c37ea1a469fdc249eba6fb65e421cf34_cgraph_map">
<area shape="rect" href="classBarry_1_1Builder.html#005a0269c1f96947d7a75c1cc09a4609" title="Same as BuildRecord, but does not care about any offsets." alt="" coords="215,5,396,32"><area shape="rect" href="classBarry_1_1Parser.html#1d8325c74140cda51c5735c6f82b7511" title="Called to parse sub fields in the raw data packet." alt="" coords="215,56,396,83"></map>
</div>
<p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1Pipe_c37ea1a469fdc249eba6fb65e421cf34_icgraph.png" border="0" usemap="#classBarry_1_1Pipe_c37ea1a469fdc249eba6fb65e421cf34_icgraph_map" alt=""></center>
<map name="classBarry_1_1Pipe_c37ea1a469fdc249eba6fb65e421cf34_icgraph_map">
<area shape="rect" href="classBarry_1_1Pipe.html#6ac2aa700bf3aa575dec422b45d1b40f" title="Reads all items from builder, feeding them into the parser, until the builder's..." alt="" coords="213,5,379,32"><area shape="rect" href="classBarry_1_1Pipe.html#0978edd4b1a8a0dcab3b6dd49b5a71ba" title="Reads all series from the builder, feeding them into the parser, until the builder's..." alt="" coords="427,5,576,32"></map>
</div>
</div>
</div><p>
<a class="anchor" name="6ac2aa700bf3aa575dec422b45d1b40f"></a><!-- doxytag: member="Barry::Pipe::PumpSeries" ref="6ac2aa700bf3aa575dec422b45d1b40f" args="(Parser &parser, const IConverter *ic=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Barry::Pipe::PumpSeries </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBarry_1_1Parser.html">Parser</a> & </td>
<td class="paramname"> <em>parser</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> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads all items from builder, feeding them into the parser, until the builder's Retrieve() signals the end of the series.
<p>
Reads all items from builder, feeding them into the parser, until the builder's Retrieve() signals the end of the series.
<p>Definition at line <a class="el" href="pipe_8cc-source.html#l00048">48</a> of file <a class="el" href="pipe_8cc-source.html">pipe.cc</a>.</p>
<p>References <a class="el" href="pipe_8cc-source.html#l00035">PumpEntry()</a>.</p>
<p>Referenced by <a class="el" href="pipe_8cc-source.html#l00056">PumpFile()</a>.</p>
<p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1Pipe_6ac2aa700bf3aa575dec422b45d1b40f_cgraph.png" border="0" usemap="#classBarry_1_1Pipe_6ac2aa700bf3aa575dec422b45d1b40f_cgraph_map" alt=""></center>
<map name="classBarry_1_1Pipe_6ac2aa700bf3aa575dec422b45d1b40f_cgraph_map">
<area shape="rect" href="classBarry_1_1Pipe.html#c37ea1a469fdc249eba6fb65e421cf34" title="Reads one item from the builder and feeds it into the parser and returns the builder..." alt="" coords="219,31,379,57"><area shape="rect" href="classBarry_1_1Builder.html#005a0269c1f96947d7a75c1cc09a4609" title="Same as BuildRecord, but does not care about any offsets." alt="" coords="428,5,609,32"><area shape="rect" href="classBarry_1_1Parser.html#1d8325c74140cda51c5735c6f82b7511" title="Called to parse sub fields in the raw data packet." alt="" coords="428,56,609,83"></map>
</div>
<p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1Pipe_6ac2aa700bf3aa575dec422b45d1b40f_icgraph.png" border="0" usemap="#classBarry_1_1Pipe_6ac2aa700bf3aa575dec422b45d1b40f_icgraph_map" alt=""></center>
<map name="classBarry_1_1Pipe_6ac2aa700bf3aa575dec422b45d1b40f_icgraph_map">
<area shape="rect" href="classBarry_1_1Pipe.html#0978edd4b1a8a0dcab3b6dd49b5a71ba" title="Reads all series from the builder, feeding them into the parser, until the builder's..." alt="" coords="219,5,368,32"></map>
</div>
</div>
</div><p>
<a class="anchor" name="0978edd4b1a8a0dcab3b6dd49b5a71ba"></a><!-- doxytag: member="Barry::Pipe::PumpFile" ref="0978edd4b1a8a0dcab3b6dd49b5a71ba" args="(Parser &parser, const IConverter *ic=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Barry::Pipe::PumpFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBarry_1_1Parser.html">Parser</a> & </td>
<td class="paramname"> <em>parser</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> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads all series from the builder, feeding them into the parser, until the builder's EndOfFile() is true.
<p>
Reads all series from the builder, feeding them into the parser, until the builder's EndOfFile() is true.
<p>Definition at line <a class="el" href="pipe_8cc-source.html#l00056">56</a> of file <a class="el" href="pipe_8cc-source.html">pipe.cc</a>.</p>
<p>References <a class="el" href="classBarry_1_1Builder.html#0ecfa5788ddee814a2071c82c5734691">Barry::Builder::EndOfFile()</a>, and <a class="el" href="pipe_8cc-source.html#l00048">PumpSeries()</a>.</p>
<p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1Pipe_0978edd4b1a8a0dcab3b6dd49b5a71ba_cgraph.png" border="0" usemap="#classBarry_1_1Pipe_0978edd4b1a8a0dcab3b6dd49b5a71ba_cgraph_map" alt=""></center>
<map name="classBarry_1_1Pipe_0978edd4b1a8a0dcab3b6dd49b5a71ba_cgraph_map">
<area shape="rect" href="classBarry_1_1Builder.html#0ecfa5788ddee814a2071c82c5734691" title="Sometimes a builder can have multiple databases stored in it, so when Build/Fetch..." alt="" coords="204,5,369,32"><area shape="rect" href="classBarry_1_1Pipe.html#6ac2aa700bf3aa575dec422b45d1b40f" title="Reads all items from builder, feeding them into the parser, until the builder's..." alt="" coords="204,56,369,83"><area shape="rect" href="classBarry_1_1Pipe.html#c37ea1a469fdc249eba6fb65e421cf34" title="Reads one item from the builder and feeds it into the parser and returns the builder..." alt="" coords="419,56,579,83"><area shape="rect" href="classBarry_1_1Builder.html#005a0269c1f96947d7a75c1cc09a4609" title="Same as BuildRecord, but does not care about any offsets." alt="" coords="628,31,809,57"><area shape="rect" href="classBarry_1_1Parser.html#1d8325c74140cda51c5735c6f82b7511" title="Called to parse sub fields in the raw data packet." alt="" coords="628,81,809,108"></map>
</div>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="pipe_8h-source.html">pipe.h</a><li><a class="el" href="pipe_8cc-source.html">pipe.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:51:03 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>
