blob: bd68e0628eea5c8ae6c2d5c9176ed3585b543ef8 [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: CommandHandlerFunctor 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_command_handler_functor.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_command_handler_functor-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">CommandHandlerFunctor 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="_command_handler_functor_8hpp_source.html">CommandHandlerFunctor.hpp</a>&gt;</code></p>
92<div class="dynheader">
93Inheritance diagram for CommandHandlerFunctor:</div>
94<div class="dyncontent">
95 <div class="center">
96 <img src="classarmnn_1_1profiling_1_1_command_handler_functor.png" usemap="#CommandHandlerFunctor_map" alt=""/>
97 <map id="CommandHandlerFunctor_map" name="CommandHandlerFunctor_map">
98<area href="classarmnn_1_1gatordmock_1_1_periodic_counter_capture_command_handler.html" alt="PeriodicCounterCaptureCommandHandler" shape="rect" coords="269,56,528,80"/>
99<area href="classarmnn_1_1gatordmock_1_1_periodic_counter_selection_response_handler.html" alt="PeriodicCounterSelectionResponseHandler" shape="rect" coords="269,112,528,136"/>
100<area href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html" alt="StreamMetadataCommandHandler" shape="rect" coords="269,168,528,192"/>
101<area href="classarmnn_1_1gatordmock_1_1_timeline_capture_command_handler.html" alt="TimelineCaptureCommandHandler" shape="rect" coords="269,224,528,248"/>
102<area href="classarmnn_1_1gatordmock_1_1_timeline_directory_capture_command_handler.html" alt="TimelineDirectoryCaptureCommandHandler" shape="rect" coords="269,280,528,304"/>
103<area href="classarmnn_1_1profiling_1_1_connection_acknowledged_command_handler.html" alt="ConnectionAcknowledgedCommandHandler" shape="rect" coords="269,336,528,360"/>
104<area href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.html" alt="DirectoryCaptureCommandHandler" shape="rect" coords="269,392,528,416"/>
105<area href="classarmnn_1_1profiling_1_1_periodic_counter_selection_command_handler.html" alt="PeriodicCounterSelectionCommandHandler" shape="rect" coords="269,448,528,472"/>
106<area href="classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.html" alt="PerJobCounterSelectionCommandHandler" shape="rect" coords="269,504,528,528"/>
107<area href="classarmnn_1_1profiling_1_1_request_counter_directory_command_handler.html" alt="RequestCounterDirectoryCommandHandler" shape="rect" coords="269,560,528,584"/>
108<area href="classarmnn_1_1profiling_1_1_test_functor_a.html" alt="TestFunctorA" shape="rect" coords="269,616,528,640"/>
109</map>
110 </div></div>
111<table class="memberdecls">
112<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
113Public Member Functions</h2></td></tr>
114<tr class="memitem:ad88cf21899e5a0ee2d803eabf3f5dd04"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html#ad88cf21899e5a0ee2d803eabf3f5dd04">CommandHandlerFunctor</a> (uint32_t familyId, uint32_t packetId, uint32_t version)</td></tr>
115<tr class="separator:ad88cf21899e5a0ee2d803eabf3f5dd04"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:a52df705001d502e24a079bd8e0c1e956"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html#a52df705001d502e24a079bd8e0c1e956">GetFamilyId</a> () const</td></tr>
117<tr class="separator:a52df705001d502e24a079bd8e0c1e956"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:a17b980d48f35a31c27a227e8ceae5402"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html#a17b980d48f35a31c27a227e8ceae5402">GetPacketId</a> () const</td></tr>
119<tr class="separator:a17b980d48f35a31c27a227e8ceae5402"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a7a9568e40773e80ab38c1a7dac4e7089"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html#a7a9568e40773e80ab38c1a7dac4e7089">GetVersion</a> () const</td></tr>
121<tr class="separator:a7a9568e40773e80ab38c1a7dac4e7089"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:aee5d34e255ea616c6b4d6877eb3c9fad"><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_command_handler_functor.html#aee5d34e255ea616c6b4d6877eb3c9fad">operator()</a> (const <a class="el" href="classarmnn_1_1profiling_1_1_packet.html">Packet</a> &amp;packet)=0</td></tr>
123<tr class="separator:aee5d34e255ea616c6b4d6877eb3c9fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a05aaf089b3b02e13bc728e2c8c94cb4e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html#a05aaf089b3b02e13bc728e2c8c94cb4e">~CommandHandlerFunctor</a> ()</td></tr>
125<tr class="separator:a05aaf089b3b02e13bc728e2c8c94cb4e"><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="_command_handler_functor_8hpp_source.html#l00020">20</a> of file <a class="el" href="_command_handler_functor_8hpp_source.html">CommandHandlerFunctor.hpp</a>.</p>
130</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
131<a id="ad88cf21899e5a0ee2d803eabf3f5dd04"></a>
132<h2 class="memtitle"><span class="permalink"><a href="#ad88cf21899e5a0ee2d803eabf3f5dd04">&#9670;&nbsp;</a></span>CommandHandlerFunctor()</h2>
133
134<div class="memitem">
135<div class="memproto">
136<table class="mlabels">
137 <tr>
138 <td class="mlabels-left">
139 <table class="memname">
140 <tr>
141 <td class="memname"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> </td>
142 <td>(</td>
143 <td class="paramtype">uint32_t&#160;</td>
144 <td class="paramname"><em>familyId</em>, </td>
145 </tr>
146 <tr>
147 <td class="paramkey"></td>
148 <td></td>
149 <td class="paramtype">uint32_t&#160;</td>
150 <td class="paramname"><em>packetId</em>, </td>
151 </tr>
152 <tr>
153 <td class="paramkey"></td>
154 <td></td>
155 <td class="paramtype">uint32_t&#160;</td>
156 <td class="paramname"><em>version</em>&#160;</td>
157 </tr>
158 <tr>
159 <td></td>
160 <td>)</td>
161 <td></td><td></td>
162 </tr>
163 </table>
164 </td>
165 <td class="mlabels-right">
166<span class="mlabels"><span class="mlabel">inline</span></span> </td>
167 </tr>
168</table>
169</div><div class="memdoc">
170
171<p class="definition">Definition at line <a class="el" href="_command_handler_functor_8hpp_source.html#l00023">23</a> of file <a class="el" href="_command_handler_functor_8hpp_source.html">CommandHandlerFunctor.hpp</a>.</p>
172
173<p class="reference">References <a class="el" href="_command_handler_functor_8cpp_source.html#l00014">CommandHandlerFunctor::GetFamilyId()</a>, <a class="el" href="_command_handler_functor_8cpp_source.html#l00019">CommandHandlerFunctor::GetPacketId()</a>, <a class="el" href="_command_handler_functor_8cpp_source.html#l00024">CommandHandlerFunctor::GetVersion()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html#aee5d34e255ea616c6b4d6877eb3c9fad">CommandHandlerFunctor::operator()()</a>.</p>
174<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; : m_FamilyId(familyId),</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; m_PacketId(packetId)</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; , m_Version(version)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {}</div></div><!-- fragment -->
175</div>
176</div>
177<a id="a05aaf089b3b02e13bc728e2c8c94cb4e"></a>
178<h2 class="memtitle"><span class="permalink"><a href="#a05aaf089b3b02e13bc728e2c8c94cb4e">&#9670;&nbsp;</a></span>~CommandHandlerFunctor()</h2>
179
180<div class="memitem">
181<div class="memproto">
182<table class="mlabels">
183 <tr>
184 <td class="mlabels-left">
185 <table class="memname">
186 <tr>
187 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> </td>
188 <td>(</td>
189 <td class="paramname"></td><td>)</td>
190 <td></td>
191 </tr>
192 </table>
193 </td>
194 <td class="mlabels-right">
195<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
196 </tr>
197</table>
198</div><div class="memdoc">
199
200<p class="definition">Definition at line <a class="el" href="_command_handler_functor_8hpp_source.html#l00035">35</a> of file <a class="el" href="_command_handler_functor_8hpp_source.html">CommandHandlerFunctor.hpp</a>.</p>
201<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{}</div></div><!-- fragment -->
202</div>
203</div>
204<h2 class="groupheader">Member Function Documentation</h2>
205<a id="a52df705001d502e24a079bd8e0c1e956"></a>
206<h2 class="memtitle"><span class="permalink"><a href="#a52df705001d502e24a079bd8e0c1e956">&#9670;&nbsp;</a></span>GetFamilyId()</h2>
207
208<div class="memitem">
209<div class="memproto">
210 <table class="memname">
211 <tr>
212 <td class="memname">uint32_t GetFamilyId </td>
213 <td>(</td>
214 <td class="paramname"></td><td>)</td>
215 <td> const</td>
216 </tr>
217 </table>
218</div><div class="memdoc">
219
220<p class="definition">Definition at line <a class="el" href="_command_handler_functor_8cpp_source.html#l00014">14</a> of file <a class="el" href="_command_handler_functor_8cpp_source.html">CommandHandlerFunctor.cpp</a>.</p>
221
222<p class="reference">Referenced by <a class="el" href="_profiling_tests_8cpp_source.html#l00324">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_command_handler_functor_8hpp_source.html#l00023">CommandHandlerFunctor::CommandHandlerFunctor()</a>, and <a class="el" href="_command_handler_registry_8cpp_source.html#l00028">CommandHandlerRegistry::RegisterFunctor()</a>.</p>
223<div class="fragment"><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keywordflow">return</span> m_FamilyId;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;}</div></div><!-- fragment -->
224</div>
225</div>
226<a id="a17b980d48f35a31c27a227e8ceae5402"></a>
227<h2 class="memtitle"><span class="permalink"><a href="#a17b980d48f35a31c27a227e8ceae5402">&#9670;&nbsp;</a></span>GetPacketId()</h2>
228
229<div class="memitem">
230<div class="memproto">
231 <table class="memname">
232 <tr>
233 <td class="memname">uint32_t GetPacketId </td>
234 <td>(</td>
235 <td class="paramname"></td><td>)</td>
236 <td> const</td>
237 </tr>
238 </table>
239</div><div class="memdoc">
240
241<p class="definition">Definition at line <a class="el" href="_command_handler_functor_8cpp_source.html#l00019">19</a> of file <a class="el" href="_command_handler_functor_8cpp_source.html">CommandHandlerFunctor.cpp</a>.</p>
242
243<p class="reference">Referenced by <a class="el" href="_profiling_tests_8cpp_source.html#l00324">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_command_handler_functor_8hpp_source.html#l00023">CommandHandlerFunctor::CommandHandlerFunctor()</a>, and <a class="el" href="_command_handler_registry_8cpp_source.html#l00028">CommandHandlerRegistry::RegisterFunctor()</a>.</p>
244<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keywordflow">return</span> m_PacketId;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;}</div></div><!-- fragment -->
245</div>
246</div>
247<a id="a7a9568e40773e80ab38c1a7dac4e7089"></a>
248<h2 class="memtitle"><span class="permalink"><a href="#a7a9568e40773e80ab38c1a7dac4e7089">&#9670;&nbsp;</a></span>GetVersion()</h2>
249
250<div class="memitem">
251<div class="memproto">
252 <table class="memname">
253 <tr>
254 <td class="memname">uint32_t GetVersion </td>
255 <td>(</td>
256 <td class="paramname"></td><td>)</td>
257 <td> const</td>
258 </tr>
259 </table>
260</div><div class="memdoc">
261
262<p class="definition">Definition at line <a class="el" href="_command_handler_functor_8cpp_source.html#l00024">24</a> of file <a class="el" href="_command_handler_functor_8cpp_source.html">CommandHandlerFunctor.cpp</a>.</p>
263
264<p class="reference">Referenced by <a class="el" href="_profiling_tests_8cpp_source.html#l00324">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_command_handler_functor_8hpp_source.html#l00023">CommandHandlerFunctor::CommandHandlerFunctor()</a>, and <a class="el" href="_command_handler_registry_8cpp_source.html#l00028">CommandHandlerRegistry::RegisterFunctor()</a>.</p>
265<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;{</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> m_Version;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;}</div></div><!-- fragment -->
266</div>
267</div>
268<a id="aee5d34e255ea616c6b4d6877eb3c9fad"></a>
269<h2 class="memtitle"><span class="permalink"><a href="#aee5d34e255ea616c6b4d6877eb3c9fad">&#9670;&nbsp;</a></span>operator()()</h2>
270
271<div class="memitem">
272<div class="memproto">
273<table class="mlabels">
274 <tr>
275 <td class="mlabels-left">
276 <table class="memname">
277 <tr>
278 <td class="memname">virtual void operator() </td>
279 <td>(</td>
280 <td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_packet.html">Packet</a> &amp;&#160;</td>
281 <td class="paramname"><em>packet</em></td><td>)</td>
282 <td></td>
283 </tr>
284 </table>
285 </td>
286 <td class="mlabels-right">
287<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
288 </tr>
289</table>
290</div><div class="memdoc">
291
292<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_functor_a.html#a0a4b0531c573c4474c241b778c5f5897">TestFunctorA</a>, <a class="el" href="classarmnn_1_1profiling_1_1_periodic_counter_selection_command_handler.html#a0a4b0531c573c4474c241b778c5f5897">PeriodicCounterSelectionCommandHandler</a>, <a class="el" href="classarmnn_1_1gatordmock_1_1_periodic_counter_capture_command_handler.html#a7ea1ce1121a51bbea9ea973c3a1463bb">PeriodicCounterCaptureCommandHandler</a>, <a class="el" href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html#a7ea1ce1121a51bbea9ea973c3a1463bb">StreamMetadataCommandHandler</a>, <a class="el" href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.html#a7ea1ce1121a51bbea9ea973c3a1463bb">DirectoryCaptureCommandHandler</a>, <a class="el" href="classarmnn_1_1gatordmock_1_1_timeline_capture_command_handler.html#a7ea1ce1121a51bbea9ea973c3a1463bb">TimelineCaptureCommandHandler</a>, <a class="el" href="classarmnn_1_1profiling_1_1_connection_acknowledged_command_handler.html#a0a4b0531c573c4474c241b778c5f5897">ConnectionAcknowledgedCommandHandler</a>, <a class="el" href="classarmnn_1_1profiling_1_1_request_counter_directory_command_handler.html#a0a4b0531c573c4474c241b778c5f5897">RequestCounterDirectoryCommandHandler</a>, <a class="el" href="classarmnn_1_1gatordmock_1_1_periodic_counter_selection_response_handler.html#a7ea1ce1121a51bbea9ea973c3a1463bb">PeriodicCounterSelectionResponseHandler</a>, <a class="el" href="classarmnn_1_1gatordmock_1_1_timeline_directory_capture_command_handler.html#a7ea1ce1121a51bbea9ea973c3a1463bb">TimelineDirectoryCaptureCommandHandler</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.html#a0a4b0531c573c4474c241b778c5f5897">PerJobCounterSelectionCommandHandler</a>.</p>
293
294<p class="reference">Referenced by <a class="el" href="_command_handler_functor_8hpp_source.html#l00023">CommandHandlerFunctor::CommandHandlerFunctor()</a>.</p>
295
296</div>
297</div>
298<hr/>The documentation for this class was generated from the following files:<ul>
299<li>src/profiling/<a class="el" href="_command_handler_functor_8hpp_source.html">CommandHandlerFunctor.hpp</a></li>
300<li>src/profiling/<a class="el" href="_command_handler_functor_8cpp_source.html">CommandHandlerFunctor.cpp</a></li>
301</ul>
302</div><!-- contents -->
303</div><!-- doc-content -->
304<!-- start footer part -->
305<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
306 <ul>
307 <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_command_handler_functor.html">CommandHandlerFunctor</a></li>
308 <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
309 <a href="http://www.doxygen.org/index.html">
310 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
311 </ul>
312</div>
313</body>
314</html>