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