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