Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 36eed46563a2a254e674865eb8ede62a1558c997 / . / Documentation / classarmnn_1_1profiling_1_1_i_backend_profiling_context.html
blob: 0f351d04ff2cc738f37b4c19383eedff07136289 [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: IBackendProfilingContext 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_context.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_context-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">IBackendProfilingContext 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_context_8hpp_source.html">IBackendProfilingContext.hpp</a>&gt;</code></p>
92<div class="dynheader">
93Inheritance diagram for IBackendProfilingContext:</div>
94<div class="dyncontent">
95 <div class="center">
96 <img src="classarmnn_1_1profiling_1_1_i_backend_profiling_context.png" usemap="#IBackendProfilingContext_map" alt=""/>
97 <map id="IBackendProfilingContext_map" name="IBackendProfilingContext_map">
98<area href="classarmnn_1_1_mock_backend_profiling_context.html" alt="MockBackendProfilingContext" shape="rect" coords="0,56,181,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: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.html#a9aeb82fc99434b8847b6274868cce79e">~IBackendProfilingContext</a> ()</td></tr>
105<tr class="separator:a9aeb82fc99434b8847b6274868cce79e"><td class="memSeparator" colspan="2">&#160;</td></tr>
106<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.html#a7877cff32ce673cece82591034759a62">RegisterCounters</a> (uint16_t currentMaxGlobalCounterID)=0</td></tr>
107<tr class="separator:a7877cff32ce673cece82591034759a62"><td class="memSeparator" colspan="2">&#160;</td></tr>
108<tr class="memitem:a73cd771233a88545d3623f35c1fad4d4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarmnn_1_1_optional.html">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.html#a73cd771233a88545d3623f35c1fad4d4">ActivateCounters</a> (uint32_t capturePeriod, const std::vector&lt; uint16_t &gt; &amp;counterIds)=0</td></tr>
109<tr class="separator:a73cd771233a88545d3623f35c1fad4d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<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.html">Timestamp</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a5a1d4c34ead611b06c3eae53f2ff47e8">ReportCounterValues</a> ()=0</td></tr>
111<tr class="separator:a5a1d4c34ead611b06c3eae53f2ff47e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<tr class="memitem:a5589708f9f5ad739add36e631a3817b5"><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_context.html#a5589708f9f5ad739add36e631a3817b5">EnableProfiling</a> (bool flag)=0</td></tr>
113<tr class="separator:a5589708f9f5ad739add36e631a3817b5"><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_backend_profiling_context_8hpp_source.html#l00016">16</a> of file <a class="el" href="_i_backend_profiling_context_8hpp_source.html">IBackendProfilingContext.hpp</a>.</p>
118</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
119<a id="a9aeb82fc99434b8847b6274868cce79e"></a>
120<h2 class="memtitle"><span class="permalink"><a href="#a9aeb82fc99434b8847b6274868cce79e">&#9670;&nbsp;</a></span>~IBackendProfilingContext()</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_backend_profiling_context.html">IBackendProfilingContext</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_backend_profiling_context_8hpp_source.html#l00019">19</a> of file <a class="el" href="_i_backend_profiling_context_8hpp_source.html">IBackendProfilingContext.hpp</a>.</p>
143
144<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a73cd771233a88545d3623f35c1fad4d4">IBackendProfilingContext::ActivateCounters()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a5589708f9f5ad739add36e631a3817b5">IBackendProfilingContext::EnableProfiling()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a7877cff32ce673cece82591034759a62">IBackendProfilingContext::RegisterCounters()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a5a1d4c34ead611b06c3eae53f2ff47e8">IBackendProfilingContext::ReportCounterValues()</a>.</p>
145<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; {}</div></div><!-- fragment -->
146</div>
147</div>
148<h2 class="groupheader">Member Function Documentation</h2>
149<a id="a73cd771233a88545d3623f35c1fad4d4"></a>
150<h2 class="memtitle"><span class="permalink"><a href="#a73cd771233a88545d3623f35c1fad4d4">&#9670;&nbsp;</a></span>ActivateCounters()</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 <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt;std::string&gt; ActivateCounters </td>
160 <td>(</td>
161 <td class="paramtype">uint32_t&#160;</td>
162 <td class="paramname"><em>capturePeriod</em>, </td>
163 </tr>
164 <tr>
165 <td class="paramkey"></td>
166 <td></td>
167 <td class="paramtype">const std::vector&lt; uint16_t &gt; &amp;&#160;</td>
168 <td class="paramname"><em>counterIds</em>&#160;</td>
169 </tr>
170 <tr>
171 <td></td>
172 <td>)</td>
173 <td></td><td></td>
174 </tr>
175 </table>
176 </td>
177 <td class="mlabels-right">
178<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
179 </tr>
180</table>
181</div><div class="memdoc">
182
183<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.html#a85f69fcb2bf44c2689f5678a8261ba84">MockBackendProfilingContext</a>.</p>
184
185<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
186
187</div>
188</div>
189<a id="a5589708f9f5ad739add36e631a3817b5"></a>
190<h2 class="memtitle"><span class="permalink"><a href="#a5589708f9f5ad739add36e631a3817b5">&#9670;&nbsp;</a></span>EnableProfiling()</h2>
191
192<div class="memitem">
193<div class="memproto">
194<table class="mlabels">
195 <tr>
196 <td class="mlabels-left">
197 <table class="memname">
198 <tr>
199 <td class="memname">virtual void EnableProfiling </td>
200 <td>(</td>
201 <td class="paramtype">bool&#160;</td>
202 <td class="paramname"><em>flag</em></td><td>)</td>
203 <td></td>
204 </tr>
205 </table>
206 </td>
207 <td class="mlabels-right">
208<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
209 </tr>
210</table>
211</div><div class="memdoc">
212
213<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.html#adedefb2326efe87593f72e1bddc0ed1b">MockBackendProfilingContext</a>.</p>
214
215<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
216
217</div>
218</div>
219<a id="a7877cff32ce673cece82591034759a62"></a>
220<h2 class="memtitle"><span class="permalink"><a href="#a7877cff32ce673cece82591034759a62">&#9670;&nbsp;</a></span>RegisterCounters()</h2>
221
222<div class="memitem">
223<div class="memproto">
224<table class="mlabels">
225 <tr>
226 <td class="mlabels-left">
227 <table class="memname">
228 <tr>
229 <td class="memname">virtual uint16_t RegisterCounters </td>
230 <td>(</td>
231 <td class="paramtype">uint16_t&#160;</td>
232 <td class="paramname"><em>currentMaxGlobalCounterID</em></td><td>)</td>
233 <td></td>
234 </tr>
235 </table>
236 </td>
237 <td class="mlabels-right">
238<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
239 </tr>
240</table>
241</div><div class="memdoc">
242
243<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.html#a6f2834ca8b2c5f299a02b4a98c91b4d6">MockBackendProfilingContext</a>.</p>
244
245<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
246
247</div>
248</div>
249<a id="a5a1d4c34ead611b06c3eae53f2ff47e8"></a>
250<h2 class="memtitle"><span class="permalink"><a href="#a5a1d4c34ead611b06c3eae53f2ff47e8">&#9670;&nbsp;</a></span>ReportCounterValues()</h2>
251
252<div class="memitem">
253<div class="memproto">
254<table class="mlabels">
255 <tr>
256 <td class="mlabels-left">
257 <table class="memname">
258 <tr>
259 <td class="memname">virtual std::vector&lt;<a class="el" href="structarmnn_1_1profiling_1_1_timestamp.html">Timestamp</a>&gt; ReportCounterValues </td>
260 <td>(</td>
261 <td class="paramname"></td><td>)</td>
262 <td></td>
263 </tr>
264 </table>
265 </td>
266 <td class="mlabels-right">
267<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
268 </tr>
269</table>
270</div><div class="memdoc">
271
272<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.html#a564b1c7251d4e994ff81994157ae6ffe">MockBackendProfilingContext</a>.</p>
273
274<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
275
276</div>
277</div>
278<hr/>The documentation for this class was generated from the following file:<ul>
279<li>include/armnn/backends/profiling/<a class="el" href="_i_backend_profiling_context_8hpp_source.html">IBackendProfilingContext.hpp</a></li>
280</ul>
281</div><!-- contents -->
282</div><!-- doc-content -->
283<!-- start footer part -->
284<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
285 <ul>
286 <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_context.html">IBackendProfilingContext</a></li>
287 <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
288 <a href="http://www.doxygen.org/index.html">
289 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
290 </ul>
291</div>
292</body>
293</html>