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