<!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::NullParser 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_1NullParser.html">NullParser</a>
</div>
</div>
<div class="contents">
<h1>Barry::NullParser Class Reference</h1><!-- doxytag: class="Barry::NullParser" --><!-- doxytag: inherits="Barry::Parser" -->
<p>If in debug mode, this class can be used as a null parser.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="parser_8h_source.html">parser.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Barry::NullParser:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1NullParser__inherit__graph.png" border="0" usemap="#Barry_1_1NullParser_inherit__map" alt="Inheritance graph"/></div>
<map name="Barry_1_1NullParser_inherit__map" id="Barry_1_1NullParser_inherit__map">
<area shape="rect" id="node2" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy." alt="" coords="16,6,117,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Barry::NullParser:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1NullParser__coll__graph.png" border="0" usemap="#Barry_1_1NullParser_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1NullParser_coll__map" id="Barry_1_1NullParser_coll__map">
<area shape="rect" id="node2" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy." alt="" coords="16,6,117,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classBarry_1_1NullParser-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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1NullParser.html#a5ee19eb4766b1a03a1bdcd710c1ed3c6">Clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and prepare for a new raw data packet. <a href="#a5ee19eb4766b1a03a1bdcd710c1ed3c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1NullParser.html#a2edd4fc6c0a876d01a503c26e196ce42">SetIds</a> (uint8_t RecType, uint32_t UniqueId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stores the IDs. <a href="#a2edd4fc6c0a876d01a503c26e196ce42"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1NullParser.html#a8cfd09252a2edb2c5b0510fb6668730a">ParseHeader</a> (const <a class="el" href="classBarry_1_1Data.html">Data</a> &data, size_t &offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to parse the header portion of the raw data packet. <a href="#a8cfd09252a2edb2c5b0510fb6668730a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1NullParser.html#a9e42a60774fb16b5a4b6762abbe628b2">ParseFields</a> (const <a class="el" href="classBarry_1_1Data.html">Data</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 parse sub fields in the raw data packet. <a href="#a9e42a60774fb16b5a4b6762abbe628b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1NullParser.html#a4f59f7c0b7688fddf8d7f91801983d9b">Store</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called at the very end of record parsing, and used to store the final packet somewhere, either in memory, disk, etc. <a href="#a4f59f7c0b7688fddf8d7f91801983d9b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>If in debug mode, this class can be used as a null parser. </p>
<p>Call <a class="el" href="namespaceBarry.html#a2e28bd59aebe0bece5a46f02ef7dbd3d" title="Barry library initializer.">Init()</a> and the protocol will be dumped to stdout and no parsing will be done.</p>
<p>Do NOT derive your own personal parser classes from this, unless you are perfectly confident that you will catch future API changes on the devel tree without the compiler's help. </p>
<p>Definition at line <a class="el" href="parser_8h_source.html#l00094">94</a> of file <a class="el" href="parser_8h_source.html">parser.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5ee19eb4766b1a03a1bdcd710c1ed3c6"></a><!-- doxytag: member="Barry::NullParser::Clear" ref="a5ee19eb4766b1a03a1bdcd710c1ed3c6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Barry::NullParser::Clear </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset and prepare for a new raw data packet. </p>
<p>Implements <a class="el" href="classBarry_1_1Parser.html#a15acb3544613d43d8f928cd63a19022b">Barry::Parser</a>.</p>
<p>Definition at line <a class="el" href="parser_8h_source.html#l00101">101</a> of file <a class="el" href="parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9e42a60774fb16b5a4b6762abbe628b2"></a><!-- doxytag: member="Barry::NullParser::ParseFields" ref="a9e42a60774fb16b5a4b6762abbe628b2" args="(const Data &data, size_t &offset, const IConverter *ic)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Barry::NullParser::ParseFields </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBarry_1_1Data.html">Data</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 parse sub fields in the raw data packet. </p>
<p>The same data is passed as was passed in ParseHeader, only the offset will be updated if it was advanced during the header parsing. </p>
<p>Implements <a class="el" href="classBarry_1_1Parser.html#a645718d87aaad3ee2c36664de05046d2">Barry::Parser</a>.</p>
<p>Definition at line <a class="el" href="parser_8h_source.html#l00115">115</a> of file <a class="el" href="parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8cfd09252a2edb2c5b0510fb6668730a"></a><!-- doxytag: member="Barry::NullParser::ParseHeader" ref="a8cfd09252a2edb2c5b0510fb6668730a" args="(const Data &data, size_t &offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Barry::NullParser::ParseHeader </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBarry_1_1Data.html">Data</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><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 parse the header portion of the raw data packet. </p>
<p>data contains the entire packet, and offset contains the location at which to start parsing. </p>
<p>Implements <a class="el" href="classBarry_1_1Parser.html#a2087d07fb5d8d57c934c4e60278f41d8">Barry::Parser</a>.</p>
<p>Definition at line <a class="el" href="parser_8h_source.html#l00109">109</a> of file <a class="el" href="parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2edd4fc6c0a876d01a503c26e196ce42"></a><!-- doxytag: member="Barry::NullParser::SetIds" ref="a2edd4fc6c0a876d01a503c26e196ce42" args="(uint8_t RecType, uint32_t UniqueId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Barry::NullParser::SetIds </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"> <em>RecType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>UniqueId</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>Stores the IDs. </p>
<p>Implements <a class="el" href="classBarry_1_1Parser.html#a95bfc4014e3e8ded94625f43d1d29800">Barry::Parser</a>.</p>
<p>Definition at line <a class="el" href="parser_8h_source.html#l00104">104</a> of file <a class="el" href="parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4f59f7c0b7688fddf8d7f91801983d9b"></a><!-- doxytag: member="Barry::NullParser::Store" ref="a4f59f7c0b7688fddf8d7f91801983d9b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Barry::NullParser::Store </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called at the very end of record parsing, and used to store the final packet somewhere, either in memory, disk, etc. </p>
<p>Implements <a class="el" href="classBarry_1_1Parser.html#abf8ab1598be74268ee486af938c527d4">Barry::Parser</a>.</p>
<p>Definition at line <a class="el" href="parser_8h_source.html#l00120">120</a> of file <a class="el" href="parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="parser_8h_source.html">parser.h</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>
