Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 36eed46563a2a254e674865eb8ede62a1558c997 / . / Documentation / classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.xhtml
blob: 26f7605d4219b111c69bb473dcd4af20ee00e16b [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: StreamMetadataCommandHandler 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_1gatordmock_1_1_stream_metadata_command_handler.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_1gatordmock_1_1_stream_metadata_command_handler-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">StreamMetadataCommandHandler Class Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_stream_metadata_command_handler_8hpp_source.xhtml">StreamMetadataCommandHandler.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for StreamMetadataCommandHandler:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.png" usemap="#StreamMetadataCommandHandler_map" alt=""/>
111 <map id="StreamMetadataCommandHandler_map" name="StreamMetadataCommandHandler_map">
112<area href="classarmnn_1_1profiling_1_1_command_handler_functor.xhtml" alt="CommandHandlerFunctor" shape="rect" coords="0,0,203,24"/>
113</map>
114 </div></div>
115<table class="memberdecls">
116<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
117Public Member Functions</h2></td></tr>
118<tr class="memitem:aa12cf392e67cb07069c9ed2b45d504d9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.xhtml#aa12cf392e67cb07069c9ed2b45d504d9">StreamMetadataCommandHandler</a> (uint32_t familyId, uint32_t packetId, uint32_t version, bool quietOperation=<a class="el" href="_ref_layer_tests_8cpp.xhtml#af3b727ae5a13ff472892ab8bda2eb1b5">false</a>)</td></tr>
119<tr class="separator:aa12cf392e67cb07069c9ed2b45d504d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a7ea1ce1121a51bbea9ea973c3a1463bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.xhtml#a7ea1ce1121a51bbea9ea973c3a1463bb">operator()</a> (const <a class="el" href="classarmnn_1_1profiling_1_1_packet.xhtml">armnn::profiling::Packet</a> &amp;packet) override</td></tr>
121<tr class="separator:a7ea1ce1121a51bbea9ea973c3a1463bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="inherit_header pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.xhtml">CommandHandlerFunctor</a></td></tr>
123<tr class="memitem:ad88cf21899e5a0ee2d803eabf3f5dd04 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><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.xhtml#ad88cf21899e5a0ee2d803eabf3f5dd04">CommandHandlerFunctor</a> (uint32_t familyId, uint32_t packetId, uint32_t version)</td></tr>
124<tr class="separator:ad88cf21899e5a0ee2d803eabf3f5dd04 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:a52df705001d502e24a079bd8e0c1e956 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><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.xhtml#a52df705001d502e24a079bd8e0c1e956">GetFamilyId</a> () const</td></tr>
126<tr class="separator:a52df705001d502e24a079bd8e0c1e956 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a17b980d48f35a31c27a227e8ceae5402 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><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.xhtml#a17b980d48f35a31c27a227e8ceae5402">GetPacketId</a> () const</td></tr>
128<tr class="separator:a17b980d48f35a31c27a227e8ceae5402 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:a7a9568e40773e80ab38c1a7dac4e7089 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><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.xhtml#a7a9568e40773e80ab38c1a7dac4e7089">GetVersion</a> () const</td></tr>
130<tr class="separator:a7a9568e40773e80ab38c1a7dac4e7089 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2">&#160;</td></tr>
131<tr class="memitem:a05aaf089b3b02e13bc728e2c8c94cb4e inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><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.xhtml#a05aaf089b3b02e13bc728e2c8c94cb4e">~CommandHandlerFunctor</a> ()</td></tr>
132<tr class="separator:a05aaf089b3b02e13bc728e2c8c94cb4e inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2">&#160;</td></tr>
133</table>
134<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
135<div class="textblock">
136<p class="definition">Definition at line <a class="el" href="_stream_metadata_command_handler_8hpp_source.xhtml#l00026">26</a> of file <a class="el" href="_stream_metadata_command_handler_8hpp_source.xhtml">StreamMetadataCommandHandler.hpp</a>.</p>
137</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
138<a id="aa12cf392e67cb07069c9ed2b45d504d9"></a>
139<h2 class="memtitle"><span class="permalink"><a href="#aa12cf392e67cb07069c9ed2b45d504d9">&#9670;&nbsp;</a></span>StreamMetadataCommandHandler()</h2>
140
141<div class="memitem">
142<div class="memproto">
143<table class="mlabels">
144 <tr>
145 <td class="mlabels-left">
146 <table class="memname">
147 <tr>
148 <td class="memname"><a class="el" href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.xhtml">StreamMetadataCommandHandler</a> </td>
149 <td>(</td>
150 <td class="paramtype">uint32_t&#160;</td>
151 <td class="paramname"><em>familyId</em>, </td>
152 </tr>
153 <tr>
154 <td class="paramkey"></td>
155 <td></td>
156 <td class="paramtype">uint32_t&#160;</td>
157 <td class="paramname"><em>packetId</em>, </td>
158 </tr>
159 <tr>
160 <td class="paramkey"></td>
161 <td></td>
162 <td class="paramtype">uint32_t&#160;</td>
163 <td class="paramname"><em>version</em>, </td>
164 </tr>
165 <tr>
166 <td class="paramkey"></td>
167 <td></td>
168 <td class="paramtype">bool&#160;</td>
169 <td class="paramname"><em>quietOperation</em> = <code><a class="el" href="_ref_layer_tests_8cpp.xhtml#af3b727ae5a13ff472892ab8bda2eb1b5">false</a></code>&#160;</td>
170 </tr>
171 <tr>
172 <td></td>
173 <td>)</td>
174 <td></td><td></td>
175 </tr>
176 </table>
177 </td>
178 <td class="mlabels-right">
179<span class="mlabels"><span class="mlabel">inline</span></span> </td>
180 </tr>
181</table>
182</div><div class="memdoc">
183<dl class="params"><dt>Parameters</dt><dd>
184 <table class="params">
185 <tr><td class="paramname">familyId</td><td>The family of the packets this handler will service </td></tr>
186 <tr><td class="paramname">packetId</td><td>The id of packets this handler will process </td></tr>
187 <tr><td class="paramname">version</td><td>The version of that id </td></tr>
188 <tr><td class="paramname">quietOperation</td><td><a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a> parameter to turn off printouts. This is useful for unit tests </td></tr>
189 </table>
190 </dd>
191</dl>
192
193<p class="definition">Definition at line <a class="el" href="_stream_metadata_command_handler_8hpp_source.xhtml#l00036">36</a> of file <a class="el" href="_stream_metadata_command_handler_8hpp_source.xhtml">StreamMetadataCommandHandler.hpp</a>.</p>
194<div class="fragment"><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; : <a class="code" href="classarmnn_1_1profiling_1_1_command_handler_functor.xhtml#ad88cf21899e5a0ee2d803eabf3f5dd04">CommandHandlerFunctor</a>(familyId, packetId, version)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; , m_QuietOperation(quietOperation)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; {}</div><div class="ttc" id="classarmnn_1_1profiling_1_1_command_handler_functor_xhtml_ad88cf21899e5a0ee2d803eabf3f5dd04"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_command_handler_functor.xhtml#ad88cf21899e5a0ee2d803eabf3f5dd04">armnn::profiling::CommandHandlerFunctor::CommandHandlerFunctor</a></div><div class="ttdeci">CommandHandlerFunctor(uint32_t familyId, uint32_t packetId, uint32_t version)</div><div class="ttdef"><b>Definition:</b> <a href="_command_handler_functor_8hpp_source.xhtml#l00023">CommandHandlerFunctor.hpp:23</a></div></div>
195</div><!-- fragment -->
196</div>
197</div>
198<h2 class="groupheader">Member Function Documentation</h2>
199<a id="a7ea1ce1121a51bbea9ea973c3a1463bb"></a>
200<h2 class="memtitle"><span class="permalink"><a href="#a7ea1ce1121a51bbea9ea973c3a1463bb">&#9670;&nbsp;</a></span>operator()()</h2>
201
202<div class="memitem">
203<div class="memproto">
204<table class="mlabels">
205 <tr>
206 <td class="mlabels-left">
207 <table class="memname">
208 <tr>
209 <td class="memname">void operator() </td>
210 <td>(</td>
211 <td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_packet.xhtml">armnn::profiling::Packet</a> &amp;&#160;</td>
212 <td class="paramname"><em>packet</em></td><td>)</td>
213 <td></td>
214 </tr>
215 </table>
216 </td>
217 <td class="mlabels-right">
218<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
219 </tr>
220</table>
221</div><div class="memdoc">
222
223<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.xhtml#aee5d34e255ea616c6b4d6877eb3c9fad">CommandHandlerFunctor</a>.</p>
224
225<p class="definition">Definition at line <a class="el" href="_stream_metadata_command_handler_8cpp_source.xhtml#l00023">23</a> of file <a class="el" href="_stream_metadata_command_handler_8cpp_source.xhtml">StreamMetadataCommandHandler.cpp</a>.</p>
226<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; ParseData(packet);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">if</span> (m_QuietOperation)</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">return</span>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; }</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; std::stringstream ss;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Stream metadata packet received&quot;</span> &lt;&lt; std::endl &lt;&lt; std::endl;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Pipe magic: &quot;</span> &lt;&lt; m_PipeMagic &lt;&lt; std::endl;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Stream metadata version: &quot;</span> &lt;&lt; m_StreamMetadataVersion &lt;&lt; std::endl;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Max data len: &quot;</span> &lt;&lt; m_MaxDataLen &lt;&lt; std::endl;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Pid: &quot;</span> &lt;&lt; m_Pid &lt;&lt; std::endl;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Software info: &quot;</span> &lt;&lt; m_SoftwareInfo &lt;&lt; std::endl;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Hardware version: &quot;</span> &lt;&lt; m_HardwareVersion &lt;&lt; std::endl;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Software version: &quot;</span> &lt;&lt; m_SoftwareVersion &lt;&lt; std::endl;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Process name: &quot;</span> &lt;&lt; m_ProcessName &lt;&lt; std::endl;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Packet versions: &quot;</span> &lt;&lt; m_PacketVersionTable.size() &lt;&lt; std::endl;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; packetVersion : m_PacketVersionTable)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;-----------------------&quot;</span> &lt;&lt; std::endl;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Packet family: &quot;</span> &lt;&lt; packetVersion.m_PacketFamily &lt;&lt; std::endl;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Packet id: &quot;</span> &lt;&lt; packetVersion.m_PacketId &lt;&lt; std::endl;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot;Packet version: &quot;</span> &lt;&lt; packetVersion.m_PacketVersion &lt;&lt; std::endl;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; std::cout &lt;&lt; ss.str() &lt;&lt; std::endl;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div></div><!-- fragment -->
227</div>
228</div>
229<hr/>The documentation for this class was generated from the following files:<ul>
230<li>tests/profiling/gatordmock/<a class="el" href="_stream_metadata_command_handler_8hpp_source.xhtml">StreamMetadataCommandHandler.hpp</a></li>
231<li>tests/profiling/gatordmock/<a class="el" href="_stream_metadata_command_handler_8cpp_source.xhtml">StreamMetadataCommandHandler.cpp</a></li>
232</ul>
233</div><!-- contents -->
234</div><!-- doc-content -->
235<!-- start footer part -->
236<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
237 <ul>
238 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1gatordmock.xhtml">gatordmock</a></li><li class="navelem"><a class="el" href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.xhtml">StreamMetadataCommandHandler</a></li>
239 <li class="footer">Generated on Fri Mar 13 2020 16:09:20 for ArmNN by
240 <a href="http://www.doxygen.org/index.html">
241 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
242 </ul>
243</div>
244</body>
245</html>