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