diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml')
-rw-r--r-- | Documentation/classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml b/Documentation/classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml new file mode 100644 index 0000000000..94603f3bb7 --- /dev/null +++ b/Documentation/classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml @@ -0,0 +1,267 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!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.13"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: IPacketBuffer Class 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.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;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">20.02</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml','');}); +</script> +<div id="doc-content"> +<!-- 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 class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarmnn_1_1profiling_1_1_i_packet_buffer-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IPacketBuffer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for IPacketBuffer:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1profiling_1_1_i_packet_buffer.png" usemap="#IPacketBuffer_map" alt=""/> + <map id="IPacketBuffer_map" name="IPacketBuffer_map"> +<area href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml" alt="IReadOnlyPacketBuffer" shape="rect" coords="77,0,221,24"/> +<area href="classarmnn_1_1profiling_1_1_mock_packet_buffer.xhtml" alt="MockPacketBuffer" shape="rect" coords="0,112,144,136"/> +<area href="classarmnn_1_1profiling_1_1_packet_buffer.xhtml" alt="PacketBuffer" shape="rect" coords="154,112,298,136"/> +</map> + </div></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:a9ded593bdc39f70c3e135e649ab3e42e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml#a9ded593bdc39f70c3e135e649ab3e42e">~IPacketBuffer</a> ()</td></tr> +<tr class="separator:a9ded593bdc39f70c3e135e649ab3e42e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4586c90cbeb7804b32dad8c1bd6ae242"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml#a4586c90cbeb7804b32dad8c1bd6ae242">Commit</a> (unsigned int size)=0</td></tr> +<tr class="separator:a4586c90cbeb7804b32dad8c1bd6ae242"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4dc7ecb0d192d6cccc9287daaf0eca0f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml#a4dc7ecb0d192d6cccc9287daaf0eca0f">Release</a> ()=0</td></tr> +<tr class="separator:a4dc7ecb0d192d6cccc9287daaf0eca0f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0dd0b11d60c79e8c89ed1b851a45030d"><td class="memItemLeft" align="right" valign="top">virtual unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml#a0dd0b11d60c79e8c89ed1b851a45030d">GetWritableData</a> ()=0</td></tr> +<tr class="separator:a0dd0b11d60c79e8c89ed1b851a45030d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml">IReadOnlyPacketBuffer</a></td></tr> +<tr class="memitem:a040a515076ec53aa5e3a933d7c7ce43c inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml#a040a515076ec53aa5e3a933d7c7ce43c">~IReadOnlyPacketBuffer</a> ()</td></tr> +<tr class="separator:a040a515076ec53aa5e3a933d7c7ce43c inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a43a27876dafdccf067777f84a97e6664 inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memItemLeft" align="right" valign="top">virtual const unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml#a43a27876dafdccf067777f84a97e6664">GetReadableData</a> () const =0</td></tr> +<tr class="separator:a43a27876dafdccf067777f84a97e6664 inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a60eae84cd5c7f05de36f64c1fdc0001c inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml#a60eae84cd5c7f05de36f64c1fdc0001c">GetSize</a> () const =0</td></tr> +<tr class="separator:a60eae84cd5c7f05de36f64c1fdc0001c inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adf275dd5054ae4d71e736ba427e1d200 inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml#adf275dd5054ae4d71e736ba427e1d200">MarkRead</a> ()=0</td></tr> +<tr class="separator:adf275dd5054ae4d71e736ba427e1d200 inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<p class="definition">Definition at line <a class="el" href="_i_packet_buffer_8hpp_source.xhtml#l00028">28</a> of file <a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a9ded593bdc39f70c3e135e649ab3e42e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9ded593bdc39f70c3e135e649ab3e42e">◆ </a></span>~IPacketBuffer()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml">IPacketBuffer</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 class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_packet_buffer_8hpp_source.xhtml#l00031">31</a> of file <a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a4586c90cbeb7804b32dad8c1bd6ae242"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4586c90cbeb7804b32dad8c1bd6ae242">◆ </a></span>Commit()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void Commit </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"><em>size</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_packet_buffer.xhtml#a1d7238f289009294f40b0b2bcb8d594f">MockPacketBuffer</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_packet_buffer.xhtml#a1d7238f289009294f40b0b2bcb8d594f">PacketBuffer</a>.</p> + +</div> +</div> +<a id="a0dd0b11d60c79e8c89ed1b851a45030d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0dd0b11d60c79e8c89ed1b851a45030d">◆ </a></span>GetWritableData()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual unsigned char* GetWritableData </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_packet_buffer.xhtml#afedc435235efffdfab1fb0670f52d7c1">MockPacketBuffer</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_packet_buffer.xhtml#a229b663a5b1c2dd9b97ded0513771fc9">PacketBuffer</a>.</p> + +</div> +</div> +<a id="a4dc7ecb0d192d6cccc9287daaf0eca0f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4dc7ecb0d192d6cccc9287daaf0eca0f">◆ </a></span>Release()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void Release </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_packet_buffer.xhtml#a1a5dddc8911f6189f9ca01394c59faaf">MockPacketBuffer</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_packet_buffer.xhtml#a1a5dddc8911f6189f9ca01394c59faaf">PacketBuffer</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>src/profiling/<a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.xhtml">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml">IPacketBuffer</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |