Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / bca73e1c82438f160364a113793d0a2195c665ac / . / Documentation / classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml
blob: 94603f3bb7be74470559f23be635ac60d5da7231 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: IPacketBuffer Class Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="classarmnn_1_1profiling_1_1_i_packet_buffer-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">IPacketBuffer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for IPacketBuffer:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_i_packet_buffer.png" usemap="#IPacketBuffer_map" alt=""/>
111 <map id="IPacketBuffer_map" name="IPacketBuffer_map">
112<area href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml" alt="IReadOnlyPacketBuffer" shape="rect" coords="77,0,221,24"/>
113<area href="classarmnn_1_1profiling_1_1_mock_packet_buffer.xhtml" alt="MockPacketBuffer" shape="rect" coords="0,112,144,136"/>
114<area href="classarmnn_1_1profiling_1_1_packet_buffer.xhtml" alt="PacketBuffer" shape="rect" coords="154,112,298,136"/>
115</map>
116 </div></div>
117<table class="memberdecls">
118<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
119Public Member Functions</h2></td></tr>
120<tr class="memitem:a9ded593bdc39f70c3e135e649ab3e42e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml#a9ded593bdc39f70c3e135e649ab3e42e">~IPacketBuffer</a> ()</td></tr>
121<tr class="separator:a9ded593bdc39f70c3e135e649ab3e42e"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a4586c90cbeb7804b32dad8c1bd6ae242"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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>
123<tr class="separator:a4586c90cbeb7804b32dad8c1bd6ae242"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a4dc7ecb0d192d6cccc9287daaf0eca0f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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>
125<tr class="separator:a4dc7ecb0d192d6cccc9287daaf0eca0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:a0dd0b11d60c79e8c89ed1b851a45030d"><td class="memItemLeft" align="right" valign="top">virtual unsigned char *&#160;</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>
127<tr class="separator:a0dd0b11d60c79e8c89ed1b851a45030d"><td class="memSeparator" colspan="2">&#160;</td></tr>
128<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="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml">IReadOnlyPacketBuffer</a></td></tr>
129<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&#160;</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>
130<tr class="separator:a040a515076ec53aa5e3a933d7c7ce43c inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memSeparator" colspan="2">&#160;</td></tr>
131<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 *&#160;</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>
132<tr class="separator:a43a27876dafdccf067777f84a97e6664 inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<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&#160;</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>
134<tr class="separator:a60eae84cd5c7f05de36f64c1fdc0001c inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memSeparator" colspan="2">&#160;</td></tr>
135<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&#160;</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>
136<tr class="separator:adf275dd5054ae4d71e736ba427e1d200 inherit pub_methods_classarmnn_1_1profiling_1_1_i_read_only_packet_buffer"><td class="memSeparator" colspan="2">&#160;</td></tr>
137</table>
138<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
139<div class="textblock">
140<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>
141</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
142<a id="a9ded593bdc39f70c3e135e649ab3e42e"></a>
143<h2 class="memtitle"><span class="permalink"><a href="#a9ded593bdc39f70c3e135e649ab3e42e">&#9670;&nbsp;</a></span>~IPacketBuffer()</h2>
144
145<div class="memitem">
146<div class="memproto">
147<table class="mlabels">
148 <tr>
149 <td class="mlabels-left">
150 <table class="memname">
151 <tr>
152 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml">IPacketBuffer</a> </td>
153 <td>(</td>
154 <td class="paramname"></td><td>)</td>
155 <td></td>
156 </tr>
157 </table>
158 </td>
159 <td class="mlabels-right">
160<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
161 </tr>
162</table>
163</div><div class="memdoc">
164
165<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>
166<div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{}</div></div><!-- fragment -->
167</div>
168</div>
169<h2 class="groupheader">Member Function Documentation</h2>
170<a id="a4586c90cbeb7804b32dad8c1bd6ae242"></a>
171<h2 class="memtitle"><span class="permalink"><a href="#a4586c90cbeb7804b32dad8c1bd6ae242">&#9670;&nbsp;</a></span>Commit()</h2>
172
173<div class="memitem">
174<div class="memproto">
175<table class="mlabels">
176 <tr>
177 <td class="mlabels-left">
178 <table class="memname">
179 <tr>
180 <td class="memname">virtual void Commit </td>
181 <td>(</td>
182 <td class="paramtype">unsigned int&#160;</td>
183 <td class="paramname"><em>size</em></td><td>)</td>
184 <td></td>
185 </tr>
186 </table>
187 </td>
188 <td class="mlabels-right">
189<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
190 </tr>
191</table>
192</div><div class="memdoc">
193
194<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>
195
196</div>
197</div>
198<a id="a0dd0b11d60c79e8c89ed1b851a45030d"></a>
199<h2 class="memtitle"><span class="permalink"><a href="#a0dd0b11d60c79e8c89ed1b851a45030d">&#9670;&nbsp;</a></span>GetWritableData()</h2>
200
201<div class="memitem">
202<div class="memproto">
203<table class="mlabels">
204 <tr>
205 <td class="mlabels-left">
206 <table class="memname">
207 <tr>
208 <td class="memname">virtual unsigned char* GetWritableData </td>
209 <td>(</td>
210 <td class="paramname"></td><td>)</td>
211 <td></td>
212 </tr>
213 </table>
214 </td>
215 <td class="mlabels-right">
216<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
217 </tr>
218</table>
219</div><div class="memdoc">
220
221<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>
222
223</div>
224</div>
225<a id="a4dc7ecb0d192d6cccc9287daaf0eca0f"></a>
226<h2 class="memtitle"><span class="permalink"><a href="#a4dc7ecb0d192d6cccc9287daaf0eca0f">&#9670;&nbsp;</a></span>Release()</h2>
227
228<div class="memitem">
229<div class="memproto">
230<table class="mlabels">
231 <tr>
232 <td class="mlabels-left">
233 <table class="memname">
234 <tr>
235 <td class="memname">virtual void Release </td>
236 <td>(</td>
237 <td class="paramname"></td><td>)</td>
238 <td></td>
239 </tr>
240 </table>
241 </td>
242 <td class="mlabels-right">
243<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
244 </tr>
245</table>
246</div><div class="memdoc">
247
248<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>
249
250</div>
251</div>
252<hr/>The documentation for this class was generated from the following file:<ul>
253<li>src/profiling/<a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a></li>
254</ul>
255</div><!-- contents -->
256</div><!-- doc-content -->
257<!-- start footer part -->
258<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
259 <ul>
260 <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>
261 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
262 <a href="http://www.doxygen.org/index.html">
263 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
264 </ul>
265</div>
266</body>
267</html>