Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1a84fe3b92aaab61d2f3b865d347459e16eb43d4 / . / Documentation / classarmnn_1_1profiling_1_1_i_read_counter_values.xhtml
blob: 48855e3a2212655cbc7bf138b4b86257a301cf7c [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: IReadCounterValues 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_read_counter_values.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_read_counter_values-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">IReadCounterValues 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_values_8hpp_source.xhtml">ICounterValues.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for IReadCounterValues:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_i_read_counter_values.png" usemap="#IReadCounterValues_map" alt=""/>
111 <map id="IReadCounterValues_map" name="IReadCounterValues_map">
112<area href="classarmnn_1_1profiling_1_1_i_read_write_counter_values.xhtml" alt="IReadWriteCounterValues" shape="rect" coords="123,56,359,80"/>
113<area href="classarmnn_1_1profiling_1_1_profiling_service.xhtml" alt="ProfilingService" shape="rect" coords="123,112,359,136"/>
114<area href="classarmnn_1_1profiling_1_1_profiling_service_runtime_helper.xhtml" alt="ProfilingServiceRuntimeHelper" shape="rect" coords="0,168,236,192"/>
115<area href="classarmnn_1_1profiling_1_1_swap_profiling_connection_factory_helper.xhtml" alt="SwapProfilingConnectionFactoryHelper" shape="rect" coords="246,168,482,192"/>
116</map>
117 </div></div>
118<table class="memberdecls">
119<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
120Public Member Functions</h2></td></tr>
121<tr class="memitem:a0ac59f90f7593e43d1d7939d2ca11a4c"><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_read_counter_values.xhtml#a0ac59f90f7593e43d1d7939d2ca11a4c">~IReadCounterValues</a> ()</td></tr>
122<tr class="separator:a0ac59f90f7593e43d1d7939d2ca11a4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:a0e2c96a05cefc72d60f5a35692a4a928"><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_read_counter_values.xhtml#a0e2c96a05cefc72d60f5a35692a4a928">IsCounterRegistered</a> (uint16_t counterUid) const =0</td></tr>
124<tr class="separator:a0e2c96a05cefc72d60f5a35692a4a928"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:acab78d0987a9cca5a9cac957be610a7d"><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_read_counter_values.xhtml#acab78d0987a9cca5a9cac957be610a7d">GetCounterCount</a> () const =0</td></tr>
126<tr class="separator:acab78d0987a9cca5a9cac957be610a7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:af0092bd7f4da4a071b29bc04aec883cd"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_read_counter_values.xhtml#af0092bd7f4da4a071b29bc04aec883cd">GetCounterValue</a> (uint16_t counterUid) const =0</td></tr>
128<tr class="separator:af0092bd7f4da4a071b29bc04aec883cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
129</table>
130<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
131<div class="textblock">
132<p class="definition">Definition at line <a class="el" href="_i_counter_values_8hpp_source.xhtml#l00016">16</a> of file <a class="el" href="_i_counter_values_8hpp_source.xhtml">ICounterValues.hpp</a>.</p>
133</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
134<a id="a0ac59f90f7593e43d1d7939d2ca11a4c"></a>
135<h2 class="memtitle"><span class="permalink"><a href="#a0ac59f90f7593e43d1d7939d2ca11a4c">&#9670;&nbsp;</a></span>~IReadCounterValues()</h2>
136
137<div class="memitem">
138<div class="memproto">
139<table class="mlabels">
140 <tr>
141 <td class="mlabels-left">
142 <table class="memname">
143 <tr>
144 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_read_counter_values.xhtml">IReadCounterValues</a> </td>
145 <td>(</td>
146 <td class="paramname"></td><td>)</td>
147 <td></td>
148 </tr>
149 </table>
150 </td>
151 <td class="mlabels-right">
152<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
153 </tr>
154</table>
155</div><div class="memdoc">
156
157<p class="definition">Definition at line <a class="el" href="_i_counter_values_8hpp_source.xhtml#l00019">19</a> of file <a class="el" href="_i_counter_values_8hpp_source.xhtml">ICounterValues.hpp</a>.</p>
158
159<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_read_counter_values.xhtml#acab78d0987a9cca5a9cac957be610a7d">IReadCounterValues::GetCounterCount()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_read_counter_values.xhtml#af0092bd7f4da4a071b29bc04aec883cd">IReadCounterValues::GetCounterValue()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_read_counter_values.xhtml#a0e2c96a05cefc72d60f5a35692a4a928">IReadCounterValues::IsCounterRegistered()</a>.</p>
160<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{}</div></div><!-- fragment -->
161</div>
162</div>
163<h2 class="groupheader">Member Function Documentation</h2>
164<a id="acab78d0987a9cca5a9cac957be610a7d"></a>
165<h2 class="memtitle"><span class="permalink"><a href="#acab78d0987a9cca5a9cac957be610a7d">&#9670;&nbsp;</a></span>GetCounterCount()</h2>
166
167<div class="memitem">
168<div class="memproto">
169<table class="mlabels">
170 <tr>
171 <td class="mlabels-left">
172 <table class="memname">
173 <tr>
174 <td class="memname">virtual uint16_t GetCounterCount </td>
175 <td>(</td>
176 <td class="paramname"></td><td>)</td>
177 <td> const</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_profiling_service.xhtml#ad9062caad1836f8e6b810e4e97bb19d1">ProfilingService</a>.</p>
188
189<p class="reference">Referenced by <a class="el" href="_i_counter_values_8hpp_source.xhtml#l00019">IReadCounterValues::~IReadCounterValues()</a>.</p>
190
191</div>
192</div>
193<a id="af0092bd7f4da4a071b29bc04aec883cd"></a>
194<h2 class="memtitle"><span class="permalink"><a href="#af0092bd7f4da4a071b29bc04aec883cd">&#9670;&nbsp;</a></span>GetCounterValue()</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 uint32_t GetCounterValue </td>
204 <td>(</td>
205 <td class="paramtype">uint16_t&#160;</td>
206 <td class="paramname"><em>counterUid</em></td><td>)</td>
207 <td> const</td>
208 </tr>
209 </table>
210 </td>
211 <td class="mlabels-right">
212<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
213 </tr>
214</table>
215</div><div class="memdoc">
216
217<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_profiling_service.xhtml#a551aeb069aa71dd81310c7635e65e53c">ProfilingService</a>.</p>
218
219<p class="reference">Referenced by <a class="el" href="_periodic_counter_capture_8cpp_source.xhtml#l00037">PeriodicCounterCapture::Stop()</a>, and <a class="el" href="_i_counter_values_8hpp_source.xhtml#l00019">IReadCounterValues::~IReadCounterValues()</a>.</p>
220
221</div>
222</div>
223<a id="a0e2c96a05cefc72d60f5a35692a4a928"></a>
224<h2 class="memtitle"><span class="permalink"><a href="#a0e2c96a05cefc72d60f5a35692a4a928">&#9670;&nbsp;</a></span>IsCounterRegistered()</h2>
225
226<div class="memitem">
227<div class="memproto">
228<table class="mlabels">
229 <tr>
230 <td class="mlabels-left">
231 <table class="memname">
232 <tr>
233 <td class="memname">virtual bool IsCounterRegistered </td>
234 <td>(</td>
235 <td class="paramtype">uint16_t&#160;</td>
236 <td class="paramname"><em>counterUid</em></td><td>)</td>
237 <td> const</td>
238 </tr>
239 </table>
240 </td>
241 <td class="mlabels-right">
242<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
243 </tr>
244</table>
245</div><div class="memdoc">
246
247<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_profiling_service.xhtml#a0ae21870422d53982556e0e31d6b19ee">ProfilingService</a>.</p>
248
249<p class="reference">Referenced by <a class="el" href="_periodic_counter_selection_command_handler_8cpp_source.xhtml#l00059">PeriodicCounterSelectionCommandHandler::operator()()</a>, and <a class="el" href="_i_counter_values_8hpp_source.xhtml#l00019">IReadCounterValues::~IReadCounterValues()</a>.</p>
250
251</div>
252</div>
253<hr/>The documentation for this class was generated from the following file:<ul>
254<li>src/profiling/<a class="el" href="_i_counter_values_8hpp_source.xhtml">ICounterValues.hpp</a></li>
255</ul>
256</div><!-- contents -->
257</div><!-- doc-content -->
258<!-- start footer part -->
259<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
260 <ul>
261 <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_read_counter_values.xhtml">IReadCounterValues</a></li>
262 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
263 <a href="http://www.doxygen.org/index.html">
264 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
265 </ul>
266</div>
267</body>
268</html>