Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / cc34093a57ea486e48f9aa66fc8b98a7bbdefef1 / . / Documentation / classarmnn_1_1profiling_1_1_i_backend_profiling.html
blob: 22a2b96ef1a1c9eb828ff22b49f4c94a22b11c8e [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: IBackendProfiling 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_backend_profiling.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_backend_profiling-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">IBackendProfiling 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_backend_profiling_8hpp_source.html">IBackendProfiling.hpp</a>&gt;</code></p>
92<div class="dynheader">
93Inheritance diagram for IBackendProfiling:</div>
94<div class="dyncontent">
95 <div class="center">
96 <img src="classarmnn_1_1profiling_1_1_i_backend_profiling.png" usemap="#IBackendProfiling_map" alt=""/>
97 <map id="IBackendProfiling_map" name="IBackendProfiling_map">
98<area href="classarmnn_1_1profiling_1_1_backend_profiling.html" alt="BackendProfiling" shape="rect" coords="0,56,111,80"/>
99</map>
100 </div></div>
101<table class="memberdecls">
102<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
103Public Member Functions</h2></td></tr>
104<tr class="memitem:a1179976118abc3d6765a5b2fea4be35c"><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_backend_profiling.html#a1179976118abc3d6765a5b2fea4be35c">~IBackendProfiling</a> ()</td></tr>
105<tr class="separator:a1179976118abc3d6765a5b2fea4be35c"><td class="memSeparator" colspan="2">&#160;</td></tr>
106<tr class="memitem:a3af5b700b06e401119749bd3a80bacf0"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.html">IRegisterBackendCounters</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a3af5b700b06e401119749bd3a80bacf0">GetCounterRegistrationInterface</a> (uint16_t currentMaxGlobalCounterID)=0</td></tr>
107<tr class="separator:a3af5b700b06e401119749bd3a80bacf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
108<tr class="memitem:af3bab90857bb0cd2363f654cdd257e34"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.html">ISendTimelinePacket</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#af3bab90857bb0cd2363f654cdd257e34">GetSendTimelinePacket</a> ()=0</td></tr>
109<tr class="separator:af3bab90857bb0cd2363f654cdd257e34"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:a9b9e803df01765cbfe9c9148fe757db5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_guid_generator.html">IProfilingGuidGenerator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a9b9e803df01765cbfe9c9148fe757db5">GetProfilingGuidGenerator</a> ()=0</td></tr>
111<tr class="separator:a9b9e803df01765cbfe9c9148fe757db5"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<tr class="memitem:a691685749cd1a917b8e6e9cb1afcc045"><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_backend_profiling.html#a691685749cd1a917b8e6e9cb1afcc045">ReportCounters</a> (const std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_timestamp.html">Timestamp</a> &gt; &amp;counterValues)=0</td></tr>
113<tr class="separator:a691685749cd1a917b8e6e9cb1afcc045"><td class="memSeparator" colspan="2">&#160;</td></tr>
114<tr class="memitem:ab159fe93b4a4357f55b55920e03b9af6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.html">CounterStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#ab159fe93b4a4357f55b55920e03b9af6">GetCounterStatus</a> (uint16_t backendCounterId)=0</td></tr>
115<tr class="separator:ab159fe93b4a4357f55b55920e03b9af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:a33b3b8d541860022fe9edecfee7284d6"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.html">CounterStatus</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a33b3b8d541860022fe9edecfee7284d6">GetActiveCounters</a> ()=0</td></tr>
117<tr class="separator:a33b3b8d541860022fe9edecfee7284d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:a93ee1c2509b9db845936a291b575dd17"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a93ee1c2509b9db845936a291b575dd17">IsProfilingEnabled</a> () const =0</td></tr>
119<tr class="separator:a93ee1c2509b9db845936a291b575dd17"><td class="memSeparator" colspan="2">&#160;</td></tr>
120</table>
121<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
122<div class="textblock">
123<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_8hpp_source.html#l00079">79</a> of file <a class="el" href="_i_backend_profiling_8hpp_source.html">IBackendProfiling.hpp</a>.</p>
124</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
125<a id="a1179976118abc3d6765a5b2fea4be35c"></a>
126<h2 class="memtitle"><span class="permalink"><a href="#a1179976118abc3d6765a5b2fea4be35c">&#9670;&nbsp;</a></span>~IBackendProfiling()</h2>
127
128<div class="memitem">
129<div class="memproto">
130<table class="mlabels">
131 <tr>
132 <td class="mlabels-left">
133 <table class="memname">
134 <tr>
135 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html">IBackendProfiling</a> </td>
136 <td>(</td>
137 <td class="paramname"></td><td>)</td>
138 <td></td>
139 </tr>
140 </table>
141 </td>
142 <td class="mlabels-right">
143<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
144 </tr>
145</table>
146</div><div class="memdoc">
147
148<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_8hpp_source.html#l00082">82</a> of file <a class="el" href="_i_backend_profiling_8hpp_source.html">IBackendProfiling.hpp</a>.</p>
149<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; {}</div></div><!-- fragment -->
150</div>
151</div>
152<h2 class="groupheader">Member Function Documentation</h2>
153<a id="a33b3b8d541860022fe9edecfee7284d6"></a>
154<h2 class="memtitle"><span class="permalink"><a href="#a33b3b8d541860022fe9edecfee7284d6">&#9670;&nbsp;</a></span>GetActiveCounters()</h2>
155
156<div class="memitem">
157<div class="memproto">
158<table class="mlabels">
159 <tr>
160 <td class="mlabels-left">
161 <table class="memname">
162 <tr>
163 <td class="memname">virtual std::vector&lt;<a class="el" href="structarmnn_1_1profiling_1_1_counter_status.html">CounterStatus</a>&gt; GetActiveCounters </td>
164 <td>(</td>
165 <td class="paramname"></td><td>)</td>
166 <td></td>
167 </tr>
168 </table>
169 </td>
170 <td class="mlabels-right">
171<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
172 </tr>
173</table>
174</div><div class="memdoc">
175
176<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a54b66ce39aa9a413d8d68f6e2569af45">BackendProfiling</a>.</p>
177
178</div>
179</div>
180<a id="a3af5b700b06e401119749bd3a80bacf0"></a>
181<h2 class="memtitle"><span class="permalink"><a href="#a3af5b700b06e401119749bd3a80bacf0">&#9670;&nbsp;</a></span>GetCounterRegistrationInterface()</h2>
182
183<div class="memitem">
184<div class="memproto">
185<table class="mlabels">
186 <tr>
187 <td class="mlabels-left">
188 <table class="memname">
189 <tr>
190 <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.html">IRegisterBackendCounters</a>&gt; GetCounterRegistrationInterface </td>
191 <td>(</td>
192 <td class="paramtype">uint16_t&#160;</td>
193 <td class="paramname"><em>currentMaxGlobalCounterID</em></td><td>)</td>
194 <td></td>
195 </tr>
196 </table>
197 </td>
198 <td class="mlabels-right">
199<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
200 </tr>
201</table>
202</div><div class="memdoc">
203
204<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a0ac323cf9d8c03c718065cd775bc2a48">BackendProfiling</a>.</p>
205
206</div>
207</div>
208<a id="ab159fe93b4a4357f55b55920e03b9af6"></a>
209<h2 class="memtitle"><span class="permalink"><a href="#ab159fe93b4a4357f55b55920e03b9af6">&#9670;&nbsp;</a></span>GetCounterStatus()</h2>
210
211<div class="memitem">
212<div class="memproto">
213<table class="mlabels">
214 <tr>
215 <td class="mlabels-left">
216 <table class="memname">
217 <tr>
218 <td class="memname">virtual <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.html">CounterStatus</a> GetCounterStatus </td>
219 <td>(</td>
220 <td class="paramtype">uint16_t&#160;</td>
221 <td class="paramname"><em>backendCounterId</em></td><td>)</td>
222 <td></td>
223 </tr>
224 </table>
225 </td>
226 <td class="mlabels-right">
227<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
228 </tr>
229</table>
230</div><div class="memdoc">
231
232<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a23d09d59f5da5d396a89c9543204dce3">BackendProfiling</a>.</p>
233
234</div>
235</div>
236<a id="a9b9e803df01765cbfe9c9148fe757db5"></a>
237<h2 class="memtitle"><span class="permalink"><a href="#a9b9e803df01765cbfe9c9148fe757db5">&#9670;&nbsp;</a></span>GetProfilingGuidGenerator()</h2>
238
239<div class="memitem">
240<div class="memproto">
241<table class="mlabels">
242 <tr>
243 <td class="mlabels-left">
244 <table class="memname">
245 <tr>
246 <td class="memname">virtual <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_guid_generator.html">IProfilingGuidGenerator</a>&amp; GetProfilingGuidGenerator </td>
247 <td>(</td>
248 <td class="paramname"></td><td>)</td>
249 <td></td>
250 </tr>
251 </table>
252 </td>
253 <td class="mlabels-right">
254<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
255 </tr>
256</table>
257</div><div class="memdoc">
258
259<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a281672bed6fd49540270725a3eea867b">BackendProfiling</a>.</p>
260
261</div>
262</div>
263<a id="af3bab90857bb0cd2363f654cdd257e34"></a>
264<h2 class="memtitle"><span class="permalink"><a href="#af3bab90857bb0cd2363f654cdd257e34">&#9670;&nbsp;</a></span>GetSendTimelinePacket()</h2>
265
266<div class="memitem">
267<div class="memproto">
268<table class="mlabels">
269 <tr>
270 <td class="mlabels-left">
271 <table class="memname">
272 <tr>
273 <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.html">ISendTimelinePacket</a>&gt; GetSendTimelinePacket </td>
274 <td>(</td>
275 <td class="paramname"></td><td>)</td>
276 <td></td>
277 </tr>
278 </table>
279 </td>
280 <td class="mlabels-right">
281<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
282 </tr>
283</table>
284</div><div class="memdoc">
285
286<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a24eb027ca494ee70c27e6322494325d8">BackendProfiling</a>.</p>
287
288</div>
289</div>
290<a id="a93ee1c2509b9db845936a291b575dd17"></a>
291<h2 class="memtitle"><span class="permalink"><a href="#a93ee1c2509b9db845936a291b575dd17">&#9670;&nbsp;</a></span>IsProfilingEnabled()</h2>
292
293<div class="memitem">
294<div class="memproto">
295<table class="mlabels">
296 <tr>
297 <td class="mlabels-left">
298 <table class="memname">
299 <tr>
300 <td class="memname">virtual bool IsProfilingEnabled </td>
301 <td>(</td>
302 <td class="paramname"></td><td>)</td>
303 <td> const</td>
304 </tr>
305 </table>
306 </td>
307 <td class="mlabels-right">
308<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
309 </tr>
310</table>
311</div><div class="memdoc">
312
313<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a70db5b1cdd0d22c1fa912c6e8b9089ce">BackendProfiling</a>.</p>
314
315</div>
316</div>
317<a id="a691685749cd1a917b8e6e9cb1afcc045"></a>
318<h2 class="memtitle"><span class="permalink"><a href="#a691685749cd1a917b8e6e9cb1afcc045">&#9670;&nbsp;</a></span>ReportCounters()</h2>
319
320<div class="memitem">
321<div class="memproto">
322<table class="mlabels">
323 <tr>
324 <td class="mlabels-left">
325 <table class="memname">
326 <tr>
327 <td class="memname">virtual void ReportCounters </td>
328 <td>(</td>
329 <td class="paramtype">const std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_timestamp.html">Timestamp</a> &gt; &amp;&#160;</td>
330 <td class="paramname"><em>counterValues</em></td><td>)</td>
331 <td></td>
332 </tr>
333 </table>
334 </td>
335 <td class="mlabels-right">
336<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
337 </tr>
338</table>
339</div><div class="memdoc">
340
341<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#aa51df0c342290615803a99525816e3e3">BackendProfiling</a>.</p>
342
343</div>
344</div>
345<hr/>The documentation for this class was generated from the following file:<ul>
346<li>include/armnn/backends/profiling/<a class="el" href="_i_backend_profiling_8hpp_source.html">IBackendProfiling.hpp</a></li>
347</ul>
348</div><!-- contents -->
349</div><!-- doc-content -->
350<!-- start footer part -->
351<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
352 <ul>
353 <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_backend_profiling.html">IBackendProfiling</a></li>
354 <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
355 <a href="http://www.doxygen.org/index.html">
356 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
357 </ul>
358</div>
359</body>
360</html>