Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 36eed46563a2a254e674865eb8ede62a1558c997 / . / Documentation / classarmnn_1_1profiling_1_1_i_counter_registry.xhtml
blob: ece92ff68a90399fca2fe7cf02a626e33da86db0 [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: ICounterRegistry 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_counter_registry.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_counter_registry-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">ICounterRegistry 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_counter_registry_8hpp_source.xhtml">ICounterRegistry.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for ICounterRegistry:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_i_counter_registry.png" usemap="#ICounterRegistry_map" alt=""/>
111 <map id="ICounterRegistry_map" name="ICounterRegistry_map">
112<area href="classarmnn_1_1profiling_1_1_counter_directory.xhtml" alt="CounterDirectory" shape="rect" coords="0,56,110,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:ae975a04ac3e352f5ed0c13501a684cb5"><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_counter_registry.xhtml#ae975a04ac3e352f5ed0c13501a684cb5">~ICounterRegistry</a> ()</td></tr>
119<tr class="separator:ae975a04ac3e352f5ed0c13501a684cb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:aefa3b1cd8c21711b682a9291c0203a8f"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_category.xhtml">Category</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml#aefa3b1cd8c21711b682a9291c0203a8f">RegisterCategory</a> (const std::string &amp;categoryName)=0</td></tr>
121<tr class="separator:aefa3b1cd8c21711b682a9291c0203a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a552c43eab6a2ba99f68f98802631db8e"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_device.xhtml">Device</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml#a552c43eab6a2ba99f68f98802631db8e">RegisterDevice</a> (const std::string &amp;deviceName, uint16_t cores, const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;parentCategoryName)=0</td></tr>
123<tr class="separator:a552c43eab6a2ba99f68f98802631db8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a0338e5b744c9c2d08143cf70d319940f"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_counter_set.xhtml">CounterSet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml#a0338e5b744c9c2d08143cf70d319940f">RegisterCounterSet</a> (const std::string &amp;counterSetName, uint16_t count, const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;parentCategoryName)=0</td></tr>
125<tr class="separator:a0338e5b744c9c2d08143cf70d319940f"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:a1d4c2bc2310f063afdf3691f3228012f"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_counter.xhtml">Counter</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml#a1d4c2bc2310f063afdf3691f3228012f">RegisterCounter</a> (const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> &amp;backendId, const uint16_t uid, const std::string &amp;parentCategoryName, uint16_t counterClass, uint16_t interpolation, double multiplier, const std::string &amp;name, const std::string &amp;description, const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;units, const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;numberOfCores, const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;deviceUid, const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;counterSetUid)=0</td></tr>
127<tr class="separator:a1d4c2bc2310f063afdf3691f3228012f"><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_counter_registry_8hpp_source.xhtml#l00017">17</a> of file <a class="el" href="_i_counter_registry_8hpp_source.xhtml">ICounterRegistry.hpp</a>.</p>
132</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
133<a id="ae975a04ac3e352f5ed0c13501a684cb5"></a>
134<h2 class="memtitle"><span class="permalink"><a href="#ae975a04ac3e352f5ed0c13501a684cb5">&#9670;&nbsp;</a></span>~ICounterRegistry()</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_counter_registry.xhtml">ICounterRegistry</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_counter_registry_8hpp_source.xhtml#l00020">20</a> of file <a class="el" href="_i_counter_registry_8hpp_source.xhtml">ICounterRegistry.hpp</a>.</p>
157
158<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml#aefa3b1cd8c21711b682a9291c0203a8f">ICounterRegistry::RegisterCategory()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml#a1d4c2bc2310f063afdf3691f3228012f">ICounterRegistry::RegisterCounter()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml#a0338e5b744c9c2d08143cf70d319940f">ICounterRegistry::RegisterCounterSet()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml#a552c43eab6a2ba99f68f98802631db8e">ICounterRegistry::RegisterDevice()</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="aefa3b1cd8c21711b682a9291c0203a8f"></a>
164<h2 class="memtitle"><span class="permalink"><a href="#aefa3b1cd8c21711b682a9291c0203a8f">&#9670;&nbsp;</a></span>RegisterCategory()</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 <a class="el" href="classarmnn_1_1profiling_1_1_category.xhtml">Category</a>* RegisterCategory </td>
174 <td>(</td>
175 <td class="paramtype">const std::string &amp;&#160;</td>
176 <td class="paramname"><em>categoryName</em></td><td>)</td>
177 <td></td>
178 </tr>
179 </table>
180 </td>
181 <td class="mlabels-right">
182<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
183 </tr>
184</table>
185</div><div class="memdoc">
186
187<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_counter_directory.xhtml#a220a83a3433b6da68d41efe07c39b552">CounterDirectory</a>.</p>
188
189<p class="reference">Referenced by <a class="el" href="_register_backend_counters_8cpp_source.xhtml#l00014">RegisterBackendCounters::RegisterCategory()</a>, and <a class="el" href="_i_counter_registry_8hpp_source.xhtml#l00020">ICounterRegistry::~ICounterRegistry()</a>.</p>
190
191</div>
192</div>
193<a id="a1d4c2bc2310f063afdf3691f3228012f"></a>
194<h2 class="memtitle"><span class="permalink"><a href="#a1d4c2bc2310f063afdf3691f3228012f">&#9670;&nbsp;</a></span>RegisterCounter()</h2>
195
196<div class="memitem">
197<div class="memproto">
198<table class="mlabels">
199 <tr>
200 <td class="mlabels-left">
201 <table class="memname">
202 <tr>
203 <td class="memname">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_counter.xhtml">Counter</a>* RegisterCounter </td>
204 <td>(</td>
205 <td class="paramtype">const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> &amp;&#160;</td>
206 <td class="paramname"><em>backendId</em>, </td>
207 </tr>
208 <tr>
209 <td class="paramkey"></td>
210 <td></td>
211 <td class="paramtype">const uint16_t&#160;</td>
212 <td class="paramname"><em>uid</em>, </td>
213 </tr>
214 <tr>
215 <td class="paramkey"></td>
216 <td></td>
217 <td class="paramtype">const std::string &amp;&#160;</td>
218 <td class="paramname"><em>parentCategoryName</em>, </td>
219 </tr>
220 <tr>
221 <td class="paramkey"></td>
222 <td></td>
223 <td class="paramtype">uint16_t&#160;</td>
224 <td class="paramname"><em>counterClass</em>, </td>
225 </tr>
226 <tr>
227 <td class="paramkey"></td>
228 <td></td>
229 <td class="paramtype">uint16_t&#160;</td>
230 <td class="paramname"><em>interpolation</em>, </td>
231 </tr>
232 <tr>
233 <td class="paramkey"></td>
234 <td></td>
235 <td class="paramtype">double&#160;</td>
236 <td class="paramname"><em>multiplier</em>, </td>
237 </tr>
238 <tr>
239 <td class="paramkey"></td>
240 <td></td>
241 <td class="paramtype">const std::string &amp;&#160;</td>
242 <td class="paramname"><em>name</em>, </td>
243 </tr>
244 <tr>
245 <td class="paramkey"></td>
246 <td></td>
247 <td class="paramtype">const std::string &amp;&#160;</td>
248 <td class="paramname"><em>description</em>, </td>
249 </tr>
250 <tr>
251 <td class="paramkey"></td>
252 <td></td>
253 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;&#160;</td>
254 <td class="paramname"><em>units</em>, </td>
255 </tr>
256 <tr>
257 <td class="paramkey"></td>
258 <td></td>
259 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;&#160;</td>
260 <td class="paramname"><em>numberOfCores</em>, </td>
261 </tr>
262 <tr>
263 <td class="paramkey"></td>
264 <td></td>
265 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;&#160;</td>
266 <td class="paramname"><em>deviceUid</em>, </td>
267 </tr>
268 <tr>
269 <td class="paramkey"></td>
270 <td></td>
271 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;&#160;</td>
272 <td class="paramname"><em>counterSetUid</em>&#160;</td>
273 </tr>
274 <tr>
275 <td></td>
276 <td>)</td>
277 <td></td><td></td>
278 </tr>
279 </table>
280 </td>
281 <td class="mlabels-right">
282<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
283 </tr>
284</table>
285</div><div class="memdoc">
286
287<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_counter_directory.xhtml#ab9756dfaf9b36cc51262369a27d1384f">CounterDirectory</a>.</p>
288
289<p class="reference">Referenced by <a class="el" href="_register_backend_counters_8cpp_source.xhtml#l00035">RegisterBackendCounters::RegisterCounter()</a>, and <a class="el" href="_i_counter_registry_8hpp_source.xhtml#l00020">ICounterRegistry::~ICounterRegistry()</a>.</p>
290
291</div>
292</div>
293<a id="a0338e5b744c9c2d08143cf70d319940f"></a>
294<h2 class="memtitle"><span class="permalink"><a href="#a0338e5b744c9c2d08143cf70d319940f">&#9670;&nbsp;</a></span>RegisterCounterSet()</h2>
295
296<div class="memitem">
297<div class="memproto">
298<table class="mlabels">
299 <tr>
300 <td class="mlabels-left">
301 <table class="memname">
302 <tr>
303 <td class="memname">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_counter_set.xhtml">CounterSet</a>* RegisterCounterSet </td>
304 <td>(</td>
305 <td class="paramtype">const std::string &amp;&#160;</td>
306 <td class="paramname"><em>counterSetName</em>, </td>
307 </tr>
308 <tr>
309 <td class="paramkey"></td>
310 <td></td>
311 <td class="paramtype">uint16_t&#160;</td>
312 <td class="paramname"><em>count</em>, </td>
313 </tr>
314 <tr>
315 <td class="paramkey"></td>
316 <td></td>
317 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;&#160;</td>
318 <td class="paramname"><em>parentCategoryName</em>&#160;</td>
319 </tr>
320 <tr>
321 <td></td>
322 <td>)</td>
323 <td></td><td></td>
324 </tr>
325 </table>
326 </td>
327 <td class="mlabels-right">
328<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
329 </tr>
330</table>
331</div><div class="memdoc">
332
333<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_counter_directory.xhtml#a161604d904508d5b86b459c2c2ace4be">CounterDirectory</a>.</p>
334
335<p class="reference">Referenced by <a class="el" href="_register_backend_counters_8cpp_source.xhtml#l00027">RegisterBackendCounters::RegisterCounterSet()</a>, and <a class="el" href="_i_counter_registry_8hpp_source.xhtml#l00020">ICounterRegistry::~ICounterRegistry()</a>.</p>
336
337</div>
338</div>
339<a id="a552c43eab6a2ba99f68f98802631db8e"></a>
340<h2 class="memtitle"><span class="permalink"><a href="#a552c43eab6a2ba99f68f98802631db8e">&#9670;&nbsp;</a></span>RegisterDevice()</h2>
341
342<div class="memitem">
343<div class="memproto">
344<table class="mlabels">
345 <tr>
346 <td class="mlabels-left">
347 <table class="memname">
348 <tr>
349 <td class="memname">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_device.xhtml">Device</a>* RegisterDevice </td>
350 <td>(</td>
351 <td class="paramtype">const std::string &amp;&#160;</td>
352 <td class="paramname"><em>deviceName</em>, </td>
353 </tr>
354 <tr>
355 <td class="paramkey"></td>
356 <td></td>
357 <td class="paramtype">uint16_t&#160;</td>
358 <td class="paramname"><em>cores</em>, </td>
359 </tr>
360 <tr>
361 <td class="paramkey"></td>
362 <td></td>
363 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;&#160;</td>
364 <td class="paramname"><em>parentCategoryName</em>&#160;</td>
365 </tr>
366 <tr>
367 <td></td>
368 <td>)</td>
369 <td></td><td></td>
370 </tr>
371 </table>
372 </td>
373 <td class="mlabels-right">
374<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
375 </tr>
376</table>
377</div><div class="memdoc">
378
379<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_counter_directory.xhtml#a6ec101239653ba9260e1362c5381e81d">CounterDirectory</a>.</p>
380
381<p class="reference">Referenced by <a class="el" href="_register_backend_counters_8cpp_source.xhtml#l00019">RegisterBackendCounters::RegisterDevice()</a>, and <a class="el" href="_i_counter_registry_8hpp_source.xhtml#l00020">ICounterRegistry::~ICounterRegistry()</a>.</p>
382
383</div>
384</div>
385<hr/>The documentation for this class was generated from the following file:<ul>
386<li>src/profiling/<a class="el" href="_i_counter_registry_8hpp_source.xhtml">ICounterRegistry.hpp</a></li>
387</ul>
388</div><!-- contents -->
389</div><!-- doc-content -->
390<!-- start footer part -->
391<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
392 <ul>
393 <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_counter_registry.xhtml">ICounterRegistry</a></li>
394 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
395 <a href="http://www.doxygen.org/index.html">
396 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
397 </ul>
398</div>
399</body>
400</html>