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