Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / f060b2e5ad65554cc8b567fb016bbaf57f6aca05 / . / Documentation / classarmnn_1_1profiling_1_1_i_backend_profiling_context.xhtml
blob: 1215160cc11972a22fda291932dd6f97eb64d083 [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: IBackendProfilingContext 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_backend_profiling_context.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_backend_profiling_context-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">IBackendProfilingContext 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_backend_profiling_context_8hpp_source.xhtml">IBackendProfilingContext.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for IBackendProfilingContext:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_i_backend_profiling_context.png" usemap="#IBackendProfilingContext_map" alt=""/>
111 <map id="IBackendProfilingContext_map" name="IBackendProfilingContext_map">
112<area href="classarmnn_1_1_mock_backend_profiling_context.xhtml" alt="MockBackendProfilingContext" shape="rect" coords="0,56,181,80"/>
113</map>
114 </div></div>
115<table class="memberdecls">
116<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
117Public Member Functions</h2></td></tr>
118<tr class="memitem:a9aeb82fc99434b8847b6274868cce79e"><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_context.xhtml#a9aeb82fc99434b8847b6274868cce79e">~IBackendProfilingContext</a> ()</td></tr>
119<tr class="separator:a9aeb82fc99434b8847b6274868cce79e"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a7877cff32ce673cece82591034759a62"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.xhtml#a7877cff32ce673cece82591034759a62">RegisterCounters</a> (uint16_t currentMaxGlobalCounterID)=0</td></tr>
121<tr class="separator:a7877cff32ce673cece82591034759a62"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a73cd771233a88545d3623f35c1fad4d4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.xhtml#a73cd771233a88545d3623f35c1fad4d4">ActivateCounters</a> (uint32_t capturePeriod, const std::vector&lt; uint16_t &gt; &amp;counterIds)=0</td></tr>
123<tr class="separator:a73cd771233a88545d3623f35c1fad4d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a5a1d4c34ead611b06c3eae53f2ff47e8"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_timestamp.xhtml">Timestamp</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.xhtml#a5a1d4c34ead611b06c3eae53f2ff47e8">ReportCounterValues</a> ()=0</td></tr>
125<tr class="separator:a5a1d4c34ead611b06c3eae53f2ff47e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:af34a12973d15f31aaec7cf6fee34ffa3"><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_context.xhtml#af34a12973d15f31aaec7cf6fee34ffa3">EnableProfiling</a> (bool flag)=0</td></tr>
127<tr class="separator:af34a12973d15f31aaec7cf6fee34ffa3"><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_backend_profiling_context_8hpp_source.xhtml#l00016">16</a> of file <a class="el" href="_i_backend_profiling_context_8hpp_source.xhtml">IBackendProfilingContext.hpp</a>.</p>
132</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
133<a id="a9aeb82fc99434b8847b6274868cce79e"></a>
134<h2 class="memtitle"><span class="permalink"><a href="#a9aeb82fc99434b8847b6274868cce79e">&#9670;&nbsp;</a></span>~IBackendProfilingContext()</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_backend_profiling_context.xhtml">IBackendProfilingContext</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_backend_profiling_context_8hpp_source.xhtml#l00019">19</a> of file <a class="el" href="_i_backend_profiling_context_8hpp_source.xhtml">IBackendProfilingContext.hpp</a>.</p>
157
158<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.xhtml#a73cd771233a88545d3623f35c1fad4d4">IBackendProfilingContext::ActivateCounters()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.xhtml#af34a12973d15f31aaec7cf6fee34ffa3">IBackendProfilingContext::EnableProfiling()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.xhtml#a7877cff32ce673cece82591034759a62">IBackendProfilingContext::RegisterCounters()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.xhtml#a5a1d4c34ead611b06c3eae53f2ff47e8">IBackendProfilingContext::ReportCounterValues()</a>.</p>
159<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; {}</div></div><!-- fragment -->
160</div>
161</div>
162<h2 class="groupheader">Member Function Documentation</h2>
163<a id="a73cd771233a88545d3623f35c1fad4d4"></a>
164<h2 class="memtitle"><span class="permalink"><a href="#a73cd771233a88545d3623f35c1fad4d4">&#9670;&nbsp;</a></span>ActivateCounters()</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 <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt;std::string&gt; ActivateCounters </td>
174 <td>(</td>
175 <td class="paramtype">uint32_t&#160;</td>
176 <td class="paramname"><em>capturePeriod</em>, </td>
177 </tr>
178 <tr>
179 <td class="paramkey"></td>
180 <td></td>
181 <td class="paramtype">const std::vector&lt; uint16_t &gt; &amp;&#160;</td>
182 <td class="paramname"><em>counterIds</em>&#160;</td>
183 </tr>
184 <tr>
185 <td></td>
186 <td>)</td>
187 <td></td><td></td>
188 </tr>
189 </table>
190 </td>
191 <td class="mlabels-right">
192<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
193 </tr>
194</table>
195</div><div class="memdoc">
196
197<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.xhtml#a85f69fcb2bf44c2689f5678a8261ba84">MockBackendProfilingContext</a>.</p>
198
199<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.xhtml#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
200
201</div>
202</div>
203<a id="af34a12973d15f31aaec7cf6fee34ffa3"></a>
204<h2 class="memtitle"><span class="permalink"><a href="#af34a12973d15f31aaec7cf6fee34ffa3">&#9670;&nbsp;</a></span>EnableProfiling()</h2>
205
206<div class="memitem">
207<div class="memproto">
208<table class="mlabels">
209 <tr>
210 <td class="mlabels-left">
211 <table class="memname">
212 <tr>
213 <td class="memname">virtual bool EnableProfiling </td>
214 <td>(</td>
215 <td class="paramtype">bool&#160;</td>
216 <td class="paramname"><em>flag</em></td><td>)</td>
217 <td></td>
218 </tr>
219 </table>
220 </td>
221 <td class="mlabels-right">
222<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
223 </tr>
224</table>
225</div><div class="memdoc">
226
227<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.xhtml#a77892a6690e47dcfd4be01bf3de9b1c5">MockBackendProfilingContext</a>.</p>
228
229<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.xhtml#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
230
231</div>
232</div>
233<a id="a7877cff32ce673cece82591034759a62"></a>
234<h2 class="memtitle"><span class="permalink"><a href="#a7877cff32ce673cece82591034759a62">&#9670;&nbsp;</a></span>RegisterCounters()</h2>
235
236<div class="memitem">
237<div class="memproto">
238<table class="mlabels">
239 <tr>
240 <td class="mlabels-left">
241 <table class="memname">
242 <tr>
243 <td class="memname">virtual uint16_t RegisterCounters </td>
244 <td>(</td>
245 <td class="paramtype">uint16_t&#160;</td>
246 <td class="paramname"><em>currentMaxGlobalCounterID</em></td><td>)</td>
247 <td></td>
248 </tr>
249 </table>
250 </td>
251 <td class="mlabels-right">
252<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
253 </tr>
254</table>
255</div><div class="memdoc">
256
257<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.xhtml#a6f2834ca8b2c5f299a02b4a98c91b4d6">MockBackendProfilingContext</a>.</p>
258
259<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.xhtml#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
260
261</div>
262</div>
263<a id="a5a1d4c34ead611b06c3eae53f2ff47e8"></a>
264<h2 class="memtitle"><span class="permalink"><a href="#a5a1d4c34ead611b06c3eae53f2ff47e8">&#9670;&nbsp;</a></span>ReportCounterValues()</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::vector&lt;<a class="el" href="structarmnn_1_1profiling_1_1_timestamp.xhtml">Timestamp</a>&gt; ReportCounterValues </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_1_mock_backend_profiling_context.xhtml#a564b1c7251d4e994ff81994157ae6ffe">MockBackendProfilingContext</a>.</p>
287
288<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.xhtml#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
289
290</div>
291</div>
292<hr/>The documentation for this class was generated from the following file:<ul>
293<li>include/armnn/backends/profiling/<a class="el" href="_i_backend_profiling_context_8hpp_source.xhtml">IBackendProfilingContext.hpp</a></li>
294</ul>
295</div><!-- contents -->
296</div><!-- doc-content -->
297<!-- start footer part -->
298<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
299 <ul>
300 <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_backend_profiling_context.xhtml">IBackendProfilingContext</a></li>
301 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
302 <a href="http://www.doxygen.org/index.html">
303 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
304 </ul>
305</div>
306</body>
307</html>