Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 36eed46563a2a254e674865eb8ede62a1558c997 / . / Documentation / classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml
blob: af1cdc3d1c89807a8e592a511d732e9894ba809f [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: IReadOnlyPacketBuffer 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_read_only_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_read_only_packet_buffer-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">IReadOnlyPacketBuffer 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 IReadOnlyPacketBuffer:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.png" usemap="#IReadOnlyPacketBuffer_map" alt=""/>
111 <map id="IReadOnlyPacketBuffer_map" name="IReadOnlyPacketBuffer_map">
112<area href="classarmnn_1_1profiling_1_1_i_packet_buffer.xhtml" alt="IPacketBuffer" shape="rect" coords="77,56,221,80"/>
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:a040a515076ec53aa5e3a933d7c7ce43c"><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>
121<tr class="separator:a040a515076ec53aa5e3a933d7c7ce43c"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a43a27876dafdccf067777f84a97e6664"><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>
123<tr class="separator:a43a27876dafdccf067777f84a97e6664"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a60eae84cd5c7f05de36f64c1fdc0001c"><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>
125<tr class="separator:a60eae84cd5c7f05de36f64c1fdc0001c"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:adf275dd5054ae4d71e736ba427e1d200"><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>
127<tr class="separator:adf275dd5054ae4d71e736ba427e1d200"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table>
129<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
130<div class="textblock">
131<p class="definition">Definition at line <a class="el" href="_i_packet_buffer_8hpp_source.xhtml#l00016">16</a> of file <a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a>.</p>
132</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
133<a id="a040a515076ec53aa5e3a933d7c7ce43c"></a>
134<h2 class="memtitle"><span class="permalink"><a href="#a040a515076ec53aa5e3a933d7c7ce43c">&#9670;&nbsp;</a></span>~IReadOnlyPacketBuffer()</h2>
135
136<div class="memitem">
137<div class="memproto">
138<table class="mlabels">
139 <tr>
140 <td class="mlabels-left">
141 <table class="memname">
142 <tr>
143 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml">IReadOnlyPacketBuffer</a> </td>
144 <td>(</td>
145 <td class="paramname"></td><td>)</td>
146 <td></td>
147 </tr>
148 </table>
149 </td>
150 <td class="mlabels-right">
151<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
152 </tr>
153</table>
154</div><div class="memdoc">
155
156<p class="definition">Definition at line <a class="el" href="_i_packet_buffer_8hpp_source.xhtml#l00019">19</a> of file <a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a>.</p>
157
158<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml#a43a27876dafdccf067777f84a97e6664">IReadOnlyPacketBuffer::GetReadableData()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml#a60eae84cd5c7f05de36f64c1fdc0001c">IReadOnlyPacketBuffer::GetSize()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_read_only_packet_buffer.xhtml#adf275dd5054ae4d71e736ba427e1d200">IReadOnlyPacketBuffer::MarkRead()</a>.</p>
159<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{}</div></div><!-- fragment -->
160</div>
161</div>
162<h2 class="groupheader">Member Function Documentation</h2>
163<a id="a43a27876dafdccf067777f84a97e6664"></a>
164<h2 class="memtitle"><span class="permalink"><a href="#a43a27876dafdccf067777f84a97e6664">&#9670;&nbsp;</a></span>GetReadableData()</h2>
165
166<div class="memitem">
167<div class="memproto">
168<table class="mlabels">
169 <tr>
170 <td class="mlabels-left">
171 <table class="memname">
172 <tr>
173 <td class="memname">virtual const unsigned char* GetReadableData </td>
174 <td>(</td>
175 <td class="paramname"></td><td>)</td>
176 <td> const</td>
177 </tr>
178 </table>
179 </td>
180 <td class="mlabels-right">
181<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
182 </tr>
183</table>
184</div><div class="memdoc">
185
186<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_packet_buffer.xhtml#a9a7614d7b084e33f72045ed161eb95bc">MockPacketBuffer</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_packet_buffer.xhtml#a58557b0c5413d3c20ddd80e31eaccaed">PacketBuffer</a>.</p>
187
188<p class="reference">Referenced by <a class="el" href="_i_packet_buffer_8hpp_source.xhtml#l00019">IReadOnlyPacketBuffer::~IReadOnlyPacketBuffer()</a>.</p>
189
190</div>
191</div>
192<a id="a60eae84cd5c7f05de36f64c1fdc0001c"></a>
193<h2 class="memtitle"><span class="permalink"><a href="#a60eae84cd5c7f05de36f64c1fdc0001c">&#9670;&nbsp;</a></span>GetSize()</h2>
194
195<div class="memitem">
196<div class="memproto">
197<table class="mlabels">
198 <tr>
199 <td class="mlabels-left">
200 <table class="memname">
201 <tr>
202 <td class="memname">virtual unsigned int GetSize </td>
203 <td>(</td>
204 <td class="paramname"></td><td>)</td>
205 <td> const</td>
206 </tr>
207 </table>
208 </td>
209 <td class="mlabels-right">
210<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
211 </tr>
212</table>
213</div><div class="memdoc">
214
215<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_packet_buffer.xhtml#ab03338cef0f6b48d46effb2c2a64407d">MockPacketBuffer</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_packet_buffer.xhtml#ab03338cef0f6b48d46effb2c2a64407d">PacketBuffer</a>.</p>
216
217<p class="reference">Referenced by <a class="el" href="_i_packet_buffer_8hpp_source.xhtml#l00019">IReadOnlyPacketBuffer::~IReadOnlyPacketBuffer()</a>.</p>
218
219</div>
220</div>
221<a id="adf275dd5054ae4d71e736ba427e1d200"></a>
222<h2 class="memtitle"><span class="permalink"><a href="#adf275dd5054ae4d71e736ba427e1d200">&#9670;&nbsp;</a></span>MarkRead()</h2>
223
224<div class="memitem">
225<div class="memproto">
226<table class="mlabels">
227 <tr>
228 <td class="mlabels-left">
229 <table class="memname">
230 <tr>
231 <td class="memname">virtual void MarkRead </td>
232 <td>(</td>
233 <td class="paramname"></td><td>)</td>
234 <td></td>
235 </tr>
236 </table>
237 </td>
238 <td class="mlabels-right">
239<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
240 </tr>
241</table>
242</div><div class="memdoc">
243
244<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_packet_buffer.xhtml#aa630bd4c9ada8ab204fbb42651b10613">MockPacketBuffer</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_packet_buffer.xhtml#aa630bd4c9ada8ab204fbb42651b10613">PacketBuffer</a>.</p>
245
246<p class="reference">Referenced by <a class="el" href="_i_packet_buffer_8hpp_source.xhtml#l00019">IReadOnlyPacketBuffer::~IReadOnlyPacketBuffer()</a>.</p>
247
248</div>
249</div>
250<hr/>The documentation for this class was generated from the following file:<ul>
251<li>src/profiling/<a class="el" href="_i_packet_buffer_8hpp_source.xhtml">IPacketBuffer.hpp</a></li>
252</ul>
253</div><!-- contents -->
254</div><!-- doc-content -->
255<!-- start footer part -->
256<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
257 <ul>
258 <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_read_only_packet_buffer.xhtml">IReadOnlyPacketBuffer</a></li>
259 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
260 <a href="http://www.doxygen.org/index.html">
261 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
262 </ul>
263</div>
264</body>
265</html>