specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
USB_Host_Shield_2.0/class_config_desc_parser.html
Kristian Sloth Lauszus 9b34049782 Updated the documentation
2018-10-13 15:47:19 +02:00

220 lines
11 KiB
HTML
Raw Blame History

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: ConfigDescParser&lt; CLASS_ID, SUBCLASS_ID, PROTOCOL_ID, MASK &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.8.14 -->
<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');
/* @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_config_desc_parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ConfigDescParser&lt; CLASS_ID, SUBCLASS_ID, PROTOCOL_ID, MASK &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="confdescparser_8h_source.html">confdescparser.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ConfigDescParser&lt; CLASS_ID, SUBCLASS_ID, PROTOCOL_ID, MASK &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_config_desc_parser__inherit__graph.png" border="0" usemap="#_config_desc_parser_3_01_c_l_a_s_s___i_d_00_01_s_u_b_c_l_a_s_s___i_d_00_01_p_r_o_t_o_c_o_l___i_d_00_01_m_a_s_k_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_config_desc_parser_3_01_c_l_a_s_s___i_d_00_01_s_u_b_c_l_a_s_s___i_d_00_01_p_r_o_t_o_c_o_l___i_d_00_01_m_a_s_k_01_4_inherit__map" id="_config_desc_parser_3_01_c_l_a_s_s___i_d_00_01_s_u_b_c_l_a_s_s___i_d_00_01_p_r_o_t_o_c_o_l___i_d_00_01_m_a_s_k_01_4_inherit__map">
<area shape="rect" id="node2" href="class_u_s_b_read_parser.html" title="USBReadParser" alt="" coords="57,5,177,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ConfigDescParser&lt; CLASS_ID, SUBCLASS_ID, PROTOCOL_ID, MASK &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_config_desc_parser__coll__graph.png" border="0" usemap="#_config_desc_parser_3_01_c_l_a_s_s___i_d_00_01_s_u_b_c_l_a_s_s___i_d_00_01_p_r_o_t_o_c_o_l___i_d_00_01_m_a_s_k_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="_config_desc_parser_3_01_c_l_a_s_s___i_d_00_01_s_u_b_c_l_a_s_s___i_d_00_01_p_r_o_t_o_c_o_l___i_d_00_01_m_a_s_k_01_4_coll__map" id="_config_desc_parser_3_01_c_l_a_s_s___i_d_00_01_s_u_b_c_l_a_s_s___i_d_00_01_p_r_o_t_o_c_o_l___i_d_00_01_m_a_s_k_01_4_coll__map">
<area shape="rect" id="node2" href="class_u_s_b_read_parser.html" title="USBReadParser" alt="" coords="57,5,177,31"/>
</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:a44807fbe19759616d5b00a912eb1229c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_config_desc_parser.html#a44807fbe19759616d5b00a912eb1229c">SetOR</a> (void)</td></tr>
<tr class="separator:a44807fbe19759616d5b00a912eb1229c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58ece11be65d0e5eed1784c31598717a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_config_desc_parser.html#a58ece11be65d0e5eed1784c31598717a">ConfigDescParser</a> (<a class="el" href="class_usb_config_xtracter.html">UsbConfigXtracter</a> *xtractor)</td></tr>
<tr class="separator:a58ece11be65d0e5eed1784c31598717a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3722ad1dbbfcd4ecf5cbf9caf08cd517"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_config_desc_parser.html#a3722ad1dbbfcd4ecf5cbf9caf08cd517">Parse</a> (const uint16_t len, const uint8_t *pbuf, const uint16_t &amp;offset)</td></tr>
<tr class="separator:a3722ad1dbbfcd4ecf5cbf9caf08cd517"><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;const uint8_t CLASS_ID, const uint8_t SUBCLASS_ID, const uint8_t PROTOCOL_ID, const uint8_t MASK&gt;<br />
class ConfigDescParser&lt; CLASS_ID, SUBCLASS_ID, PROTOCOL_ID, MASK &gt;</h3>
<p class="definition">Definition at line <a class="el" href="confdescparser_8h_source.html#l00047">47</a> of file <a class="el" href="confdescparser_8h_source.html">confdescparser.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a58ece11be65d0e5eed1784c31598717a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58ece11be65d0e5eed1784c31598717a">&#9670;&nbsp;</a></span>ConfigDescParser()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t CLASS_ID, const uint8_t SUBCLASS_ID, const uint8_t PROTOCOL_ID, const uint8_t MASK&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_config_desc_parser.html">ConfigDescParser</a>&lt; CLASS_ID, SUBCLASS_ID, PROTOCOL_ID, MASK &gt;::<a class="el" href="class_config_desc_parser.html">ConfigDescParser</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_usb_config_xtracter.html">UsbConfigXtracter</a> *&#160;</td>
<td class="paramname"><em>xtractor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="confdescparser_8h_source.html#l00079">79</a> of file <a class="el" href="confdescparser_8h_source.html">confdescparser.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a44807fbe19759616d5b00a912eb1229c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44807fbe19759616d5b00a912eb1229c">&#9670;&nbsp;</a></span>SetOR()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t CLASS_ID, const uint8_t SUBCLASS_ID, const uint8_t PROTOCOL_ID, const uint8_t MASK&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_config_desc_parser.html">ConfigDescParser</a>&lt; CLASS_ID, SUBCLASS_ID, PROTOCOL_ID, MASK &gt;::SetOR </td>
<td>(</td>
<td class="paramtype">void&#160;</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="confdescparser_8h_source.html#l00071">71</a> of file <a class="el" href="confdescparser_8h_source.html">confdescparser.h</a>.</p>
</div>
</div>
<a id="a3722ad1dbbfcd4ecf5cbf9caf08cd517"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3722ad1dbbfcd4ecf5cbf9caf08cd517">&#9670;&nbsp;</a></span>Parse()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;const uint8_t CLASS_ID, const uint8_t SUBCLASS_ID, const uint8_t PROTOCOL_ID, const uint8_t MASK&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_config_desc_parser.html">ConfigDescParser</a>&lt; CLASS_ID, SUBCLASS_ID, PROTOCOL_ID, MASK &gt;::Parse </td>
<td>(</td>
<td class="paramtype">const uint16_t&#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 uint16_t &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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_u_s_b_read_parser.html#afdb9cea2a2fe18d26f4ec595b86a7f7c">USBReadParser</a>.</p>
<p class="definition">Definition at line <a class="el" href="confdescparser_8h_source.html#l00091">91</a> of file <a class="el" href="confdescparser_8h_source.html">confdescparser.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="confdescparser_8h_source.html">confdescparser.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink