USB_Host_Shield_2.0/class_sink_parser.html
2022-12-15 10:52:18 +00:00

223 lines
10 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: SinkParser&lt; BASE_CLASS, LEN_TYPE, OFFSET_TYPE &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_sink_parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SinkParser&lt; BASE_CLASS, LEN_TYPE, OFFSET_TYPE &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="sink__parser_8h_source.html">sink_parser.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SinkParser&lt; BASE_CLASS, LEN_TYPE, OFFSET_TYPE &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_sink_parser__inherit__graph.png" border="0" usemap="#a_sink_parser_3_01_b_a_s_e___c_l_a_s_s_00_01_l_e_n___t_y_p_e_00_01_o_f_f_s_e_t___t_y_p_e_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="a_sink_parser_3_01_b_a_s_e___c_l_a_s_s_00_01_l_e_n___t_y_p_e_00_01_o_f_f_s_e_t___t_y_p_e_01_4_inherit__map" id="a_sink_parser_3_01_b_a_s_e___c_l_a_s_s_00_01_l_e_n___t_y_p_e_00_01_o_f_f_s_e_t___t_y_p_e_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,207,121"/>
<area shape="rect" title=" " alt="" coords="53,5,159,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for SinkParser&lt; BASE_CLASS, LEN_TYPE, OFFSET_TYPE &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_sink_parser__coll__graph.png" border="0" usemap="#a_sink_parser_3_01_b_a_s_e___c_l_a_s_s_00_01_l_e_n___t_y_p_e_00_01_o_f_f_s_e_t___t_y_p_e_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="a_sink_parser_3_01_b_a_s_e___c_l_a_s_s_00_01_l_e_n___t_y_p_e_00_01_o_f_f_s_e_t___t_y_p_e_01_4_coll__map" id="a_sink_parser_3_01_b_a_s_e___c_l_a_s_s_00_01_l_e_n___t_y_p_e_00_01_o_f_f_s_e_t___t_y_p_e_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="5,80,207,121"/>
<area shape="rect" title=" " alt="" coords="53,5,159,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a68caa440ba95a184eb104535f3fffd17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sink_parser.html#a68caa440ba95a184eb104535f3fffd17">SinkParser</a> ()</td></tr>
<tr class="separator:a68caa440ba95a184eb104535f3fffd17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c2ac73b459e326e955c26d658733f9f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sink_parser.html#a3c2ac73b459e326e955c26d658733f9f">Initialize</a> ()</td></tr>
<tr class="separator:a3c2ac73b459e326e955c26d658733f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6cf61bb48d61cb7db178c62c5f86fd0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sink_parser.html#ac6cf61bb48d61cb7db178c62c5f86fd0">Parse</a> (const LEN_TYPE len, const uint8_t *pbuf, const OFFSET_TYPE &amp;offset)</td></tr>
<tr class="separator:ac6cf61bb48d61cb7db178c62c5f86fd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class BASE_CLASS, class LEN_TYPE, class OFFSET_TYPE&gt;<br />
class SinkParser&lt; BASE_CLASS, LEN_TYPE, OFFSET_TYPE &gt;</h3>
<p class="definition">Definition at line <a class="el" href="sink__parser_8h_source.html#l00035">35</a> of file <a class="el" href="sink__parser_8h_source.html">sink_parser.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a68caa440ba95a184eb104535f3fffd17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68caa440ba95a184eb104535f3fffd17">&#9670;&nbsp;</a></span>SinkParser()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BASE_CLASS , class LEN_TYPE , class OFFSET_TYPE &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_sink_parser.html">SinkParser</a>&lt; BASE_CLASS, LEN_TYPE, OFFSET_TYPE &gt;::<a class="el" href="class_sink_parser.html">SinkParser</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sink__parser_8h_source.html#l00038">38</a> of file <a class="el" href="sink__parser_8h_source.html">sink_parser.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3c2ac73b459e326e955c26d658733f9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c2ac73b459e326e955c26d658733f9f">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BASE_CLASS , class LEN_TYPE , class OFFSET_TYPE &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_sink_parser.html">SinkParser</a>&lt; BASE_CLASS, LEN_TYPE, OFFSET_TYPE &gt;::Initialize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sink__parser_8h_source.html#l00041">41</a> of file <a class="el" href="sink__parser_8h_source.html">sink_parser.h</a>.</p>
</div>
</div>
<a id="ac6cf61bb48d61cb7db178c62c5f86fd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6cf61bb48d61cb7db178c62c5f86fd0">&#9670;&nbsp;</a></span>Parse()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BASE_CLASS , class LEN_TYPE , class OFFSET_TYPE &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_sink_parser.html">SinkParser</a>&lt; BASE_CLASS, LEN_TYPE, OFFSET_TYPE &gt;::Parse </td>
<td>(</td>
<td class="paramtype">const LEN_TYPE&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>pbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const OFFSET_TYPE &amp;&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sink__parser_8h_source.html#l00044">44</a> of file <a class="el" href="sink__parser_8h_source.html">sink_parser.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="sink__parser_8h_source.html">sink_parser.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>