blob: bf2d9f05e57f139dab5ad735bd7774f3666563dd [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +00001<!-- 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: ISendCounterPacket 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_send_counter_packet.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-types">Public Types</a> &#124;
99<a href="#pub-methods">Public Member Functions</a> &#124;
100<a href="classarmnn_1_1profiling_1_1_i_send_counter_packet-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">ISendCounterPacket Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p><code>#include &lt;<a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a>&gt;</code></p>
107<div class="dynheader">
108Inheritance diagram for ISendCounterPacket:</div>
109<div class="dyncontent">
110 <div class="center">
111 <img src="classarmnn_1_1profiling_1_1_i_send_counter_packet.png" usemap="#ISendCounterPacket_map" alt=""/>
112 <map id="ISendCounterPacket_map" name="ISendCounterPacket_map">
113<area href="classarmnn_1_1profiling_1_1_mock_send_counter_packet.xhtml" alt="MockSendCounterPacket" shape="rect" coords="0,56,155,80"/>
114<area href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml" alt="SendCounterPacket" shape="rect" coords="165,56,320,80"/>
115<area href="classarmnn_1_1profiling_1_1_send_counter_packet_test.xhtml" alt="SendCounterPacketTest" shape="rect" coords="165,112,320,136"/>
116</map>
117 </div></div>
118<table class="memberdecls">
119<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
120Public Types</h2></td></tr>
121<tr class="memitem:a80cb41c63cb6d3a19870b3a0a8f21ba7"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a80cb41c63cb6d3a19870b3a0a8f21ba7">IndexValuePairsVector</a> = std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_counter_value.xhtml">CounterValue</a> &gt;</td></tr>
122<tr class="separator:a80cb41c63cb6d3a19870b3a0a8f21ba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
123</table><table class="memberdecls">
124<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
125Public Member Functions</h2></td></tr>
126<tr class="memitem:a583357d6511e6cb6084829e4f7cd1315"><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_send_counter_packet.xhtml#a583357d6511e6cb6084829e4f7cd1315">~ISendCounterPacket</a> ()</td></tr>
127<tr class="separator:a583357d6511e6cb6084829e4f7cd1315"><td class="memSeparator" colspan="2">&#160;</td></tr>
128<tr class="memitem:a14e9efe48e3d4ed05396f8a856bfaeea"><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_send_counter_packet.xhtml#a14e9efe48e3d4ed05396f8a856bfaeea">SendStreamMetaDataPacket</a> ()=0</td></tr>
129<tr class="memdesc:a14e9efe48e3d4ed05396f8a856bfaeea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write a StreamMetaDataPacket in the buffer. <a href="#a14e9efe48e3d4ed05396f8a856bfaeea">More...</a><br /></td></tr>
130<tr class="separator:a14e9efe48e3d4ed05396f8a856bfaeea"><td class="memSeparator" colspan="2">&#160;</td></tr>
131<tr class="memitem:ae3331355e62b6008340c27e82be9a851"><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_send_counter_packet.xhtml#ae3331355e62b6008340c27e82be9a851">SendCounterDirectoryPacket</a> (const <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_directory.xhtml">ICounterDirectory</a> &amp;counterDirectory)=0</td></tr>
132<tr class="memdesc:ae3331355e62b6008340c27e82be9a851"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write a CounterDirectoryPacket from the parameters to the buffer. <a href="#ae3331355e62b6008340c27e82be9a851">More...</a><br /></td></tr>
133<tr class="separator:ae3331355e62b6008340c27e82be9a851"><td class="memSeparator" colspan="2">&#160;</td></tr>
134<tr class="memitem:aeacf0722dbf513d511b46a9bf43bfa4a"><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_send_counter_packet.xhtml#aeacf0722dbf513d511b46a9bf43bfa4a">SendPeriodicCounterCapturePacket</a> (uint64_t timestamp, const <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a80cb41c63cb6d3a19870b3a0a8f21ba7">IndexValuePairsVector</a> &amp;values)=0</td></tr>
135<tr class="memdesc:aeacf0722dbf513d511b46a9bf43bfa4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write a PeriodicCounterCapturePacket from the parameters to the buffer. <a href="#aeacf0722dbf513d511b46a9bf43bfa4a">More...</a><br /></td></tr>
136<tr class="separator:aeacf0722dbf513d511b46a9bf43bfa4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
137<tr class="memitem:a6435f063192414c6dc68ef2f31628a5c"><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_send_counter_packet.xhtml#a6435f063192414c6dc68ef2f31628a5c">SendPeriodicCounterSelectionPacket</a> (uint32_t capturePeriod, const std::vector&lt; uint16_t &gt; &amp;selectedCounterIds)=0</td></tr>
138<tr class="memdesc:a6435f063192414c6dc68ef2f31628a5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write a PeriodicCounterSelectionPacket from the parameters to the buffer. <a href="#a6435f063192414c6dc68ef2f31628a5c">More...</a><br /></td></tr>
139<tr class="separator:a6435f063192414c6dc68ef2f31628a5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
140</table>
141<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
142<div class="textblock">
143<p class="definition">Definition at line <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00017">17</a> of file <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a>.</p>
144</div><h2 class="groupheader">Member Typedef Documentation</h2>
145<a id="a80cb41c63cb6d3a19870b3a0a8f21ba7"></a>
146<h2 class="memtitle"><span class="permalink"><a href="#a80cb41c63cb6d3a19870b3a0a8f21ba7">&#9670;&nbsp;</a></span>IndexValuePairsVector</h2>
147
148<div class="memitem">
149<div class="memproto">
150 <table class="memname">
151 <tr>
152 <td class="memname">using <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a80cb41c63cb6d3a19870b3a0a8f21ba7">IndexValuePairsVector</a> = std::vector&lt;<a class="el" href="structarmnn_1_1profiling_1_1_counter_value.xhtml">CounterValue</a>&gt;</td>
153 </tr>
154 </table>
155</div><div class="memdoc">
156
157<p class="definition">Definition at line <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00020">20</a> of file <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a>.</p>
158
159</div>
160</div>
161<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
162<a id="a583357d6511e6cb6084829e4f7cd1315"></a>
163<h2 class="memtitle"><span class="permalink"><a href="#a583357d6511e6cb6084829e4f7cd1315">&#9670;&nbsp;</a></span>~ISendCounterPacket()</h2>
164
165<div class="memitem">
166<div class="memproto">
167<table class="mlabels">
168 <tr>
169 <td class="mlabels-left">
170 <table class="memname">
171 <tr>
172 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml">ISendCounterPacket</a> </td>
173 <td>(</td>
174 <td class="paramname"></td><td>)</td>
175 <td></td>
176 </tr>
177 </table>
178 </td>
179 <td class="mlabels-right">
180<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
181 </tr>
182</table>
183</div><div class="memdoc">
184
185<p class="definition">Definition at line <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00022">22</a> of file <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a>.</p>
186
187<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#ae3331355e62b6008340c27e82be9a851">ISendCounterPacket::SendCounterDirectoryPacket()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#aeacf0722dbf513d511b46a9bf43bfa4a">ISendCounterPacket::SendPeriodicCounterCapturePacket()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a6435f063192414c6dc68ef2f31628a5c">ISendCounterPacket::SendPeriodicCounterSelectionPacket()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a14e9efe48e3d4ed05396f8a856bfaeea">ISendCounterPacket::SendStreamMetaDataPacket()</a>.</p>
188<div class="fragment"><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{}</div></div><!-- fragment -->
189</div>
190</div>
191<h2 class="groupheader">Member Function Documentation</h2>
192<a id="ae3331355e62b6008340c27e82be9a851"></a>
193<h2 class="memtitle"><span class="permalink"><a href="#ae3331355e62b6008340c27e82be9a851">&#9670;&nbsp;</a></span>SendCounterDirectoryPacket()</h2>
194
195<div class="memitem">
196<div class="memproto">
197<table class="mlabels">
198 <tr>
199 <td class="mlabels-left">
200 <table class="memname">
201 <tr>
202 <td class="memname">virtual void SendCounterDirectoryPacket </td>
203 <td>(</td>
204 <td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_directory.xhtml">ICounterDirectory</a> &amp;&#160;</td>
205 <td class="paramname"><em>counterDirectory</em></td><td>)</td>
206 <td></td>
207 </tr>
208 </table>
209 </td>
210 <td class="mlabels-right">
211<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
212 </tr>
213</table>
214</div><div class="memdoc">
215
216<p>Create and write a CounterDirectoryPacket from the parameters to the buffer. </p>
217
218<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_send_counter_packet.xhtml#a3b526a823530443efec886c4305e52de">MockSendCounterPacket</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml#a3b526a823530443efec886c4305e52de">SendCounterPacket</a>.</p>
219
220<p class="reference">Referenced by <a class="el" href="_connection_acknowledged_command_handler_8cpp_source.xhtml#l00018">ConnectionAcknowledgedCommandHandler::operator()()</a>, <a class="el" href="_request_counter_directory_command_handler_8cpp_source.xhtml#l00016">RequestCounterDirectoryCommandHandler::operator()()</a>, and <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00022">ISendCounterPacket::~ISendCounterPacket()</a>.</p>
221
222</div>
223</div>
224<a id="aeacf0722dbf513d511b46a9bf43bfa4a"></a>
225<h2 class="memtitle"><span class="permalink"><a href="#aeacf0722dbf513d511b46a9bf43bfa4a">&#9670;&nbsp;</a></span>SendPeriodicCounterCapturePacket()</h2>
226
227<div class="memitem">
228<div class="memproto">
229<table class="mlabels">
230 <tr>
231 <td class="mlabels-left">
232 <table class="memname">
233 <tr>
234 <td class="memname">virtual void SendPeriodicCounterCapturePacket </td>
235 <td>(</td>
236 <td class="paramtype">uint64_t&#160;</td>
237 <td class="paramname"><em>timestamp</em>, </td>
238 </tr>
239 <tr>
240 <td class="paramkey"></td>
241 <td></td>
242 <td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a80cb41c63cb6d3a19870b3a0a8f21ba7">IndexValuePairsVector</a> &amp;&#160;</td>
243 <td class="paramname"><em>values</em>&#160;</td>
244 </tr>
245 <tr>
246 <td></td>
247 <td>)</td>
248 <td></td><td></td>
249 </tr>
250 </table>
251 </td>
252 <td class="mlabels-right">
253<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
254 </tr>
255</table>
256</div><div class="memdoc">
257
258<p>Create and write a PeriodicCounterCapturePacket from the parameters to the buffer. </p>
259
260<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml#adae3557b7778010227466ce3eed0edb2">SendCounterPacket</a>.</p>
261
262<p class="reference">Referenced by <a class="el" href="_backend_profiling_8cpp_source.xhtml#l00032">BackendProfiling::ReportCounters()</a>, <a class="el" href="_periodic_counter_capture_8cpp_source.xhtml#l00037">PeriodicCounterCapture::Stop()</a>, and <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00022">ISendCounterPacket::~ISendCounterPacket()</a>.</p>
263
264</div>
265</div>
266<a id="a6435f063192414c6dc68ef2f31628a5c"></a>
267<h2 class="memtitle"><span class="permalink"><a href="#a6435f063192414c6dc68ef2f31628a5c">&#9670;&nbsp;</a></span>SendPeriodicCounterSelectionPacket()</h2>
268
269<div class="memitem">
270<div class="memproto">
271<table class="mlabels">
272 <tr>
273 <td class="mlabels-left">
274 <table class="memname">
275 <tr>
276 <td class="memname">virtual void SendPeriodicCounterSelectionPacket </td>
277 <td>(</td>
278 <td class="paramtype">uint32_t&#160;</td>
279 <td class="paramname"><em>capturePeriod</em>, </td>
280 </tr>
281 <tr>
282 <td class="paramkey"></td>
283 <td></td>
284 <td class="paramtype">const std::vector&lt; uint16_t &gt; &amp;&#160;</td>
285 <td class="paramname"><em>selectedCounterIds</em>&#160;</td>
286 </tr>
287 <tr>
288 <td></td>
289 <td>)</td>
290 <td></td><td></td>
291 </tr>
292 </table>
293 </td>
294 <td class="mlabels-right">
295<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
296 </tr>
297</table>
298</div><div class="memdoc">
299
300<p>Create and write a PeriodicCounterSelectionPacket from the parameters to the buffer. </p>
301
302<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_send_counter_packet.xhtml#a47406a4d108beb4f20031d370a155a9d">MockSendCounterPacket</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml#a47406a4d108beb4f20031d370a155a9d">SendCounterPacket</a>.</p>
303
304<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_send_counter_packet_8hpp_source.xhtml#l00022">ISendCounterPacket::~ISendCounterPacket()</a>.</p>
305
306</div>
307</div>
308<a id="a14e9efe48e3d4ed05396f8a856bfaeea"></a>
309<h2 class="memtitle"><span class="permalink"><a href="#a14e9efe48e3d4ed05396f8a856bfaeea">&#9670;&nbsp;</a></span>SendStreamMetaDataPacket()</h2>
310
311<div class="memitem">
312<div class="memproto">
313<table class="mlabels">
314 <tr>
315 <td class="mlabels-left">
316 <table class="memname">
317 <tr>
318 <td class="memname">virtual void SendStreamMetaDataPacket </td>
319 <td>(</td>
320 <td class="paramname"></td><td>)</td>
321 <td></td>
322 </tr>
323 </table>
324 </td>
325 <td class="mlabels-right">
326<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
327 </tr>
328</table>
329</div><div class="memdoc">
330
331<p>Create and write a StreamMetaDataPacket in the buffer. </p>
332
333<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_send_counter_packet.xhtml#a2a2e451c4e4963909b8a6dc7e7653cd1">MockSendCounterPacket</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml#a2a2e451c4e4963909b8a6dc7e7653cd1">SendCounterPacket</a>.</p>
334
335<p class="reference">Referenced by <a class="el" href="_send_thread_8cpp_source.xhtml#l00081">SendThread::Stop()</a>, and <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00022">ISendCounterPacket::~ISendCounterPacket()</a>.</p>
336
337</div>
338</div>
339<hr/>The documentation for this class was generated from the following file:<ul>
340<li>src/profiling/<a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a></li>
341</ul>
342</div><!-- contents -->
343</div><!-- doc-content -->
344<!-- start footer part -->
345<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
346 <ul>
347 <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_send_counter_packet.xhtml">ISendCounterPacket</a></li>
348 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
349 <a href="http://www.doxygen.org/index.html">
350 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
351 </ul>
352</div>
353</body>
354</html>