Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 9fabf4336bb1e966f3fa192106dcb46562deebcd / . / Documentation / classarmnn_1_1profiling_1_1_command_handler_registry.html
blob: f4ad3e73d27ca7893281e6da9cf3801092b7d9e7 [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: CommandHandlerRegistry 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_registry.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_registry-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">CommandHandlerRegistry Class Reference</div> </div>
88</div><!--header-->
89<div class="contents">
90
91<p><code>#include &lt;<a class="el" href="_command_handler_registry_8hpp_source.html">CommandHandlerRegistry.hpp</a>&gt;</code></p>
92<table class="memberdecls">
93<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
94Public Member Functions</h2></td></tr>
95<tr class="memitem:a46f9edb3e365423b93373629e9a13509"><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_registry.html#a46f9edb3e365423b93373629e9a13509">CommandHandlerRegistry</a> ()=default</td></tr>
96<tr class="separator:a46f9edb3e365423b93373629e9a13509"><td class="memSeparator" colspan="2">&#160;</td></tr>
97<tr class="memitem:a7875d60ac5ca76c70f599367ec61261a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_registry.html#a7875d60ac5ca76c70f599367ec61261a">RegisterFunctor</a> (<a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> *functor, uint32_t familyId, uint32_t packetId, uint32_t version)</td></tr>
98<tr class="separator:a7875d60ac5ca76c70f599367ec61261a"><td class="memSeparator" colspan="2">&#160;</td></tr>
99<tr class="memitem:ae56042d93e16ea2c1e99233fc0451d51"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_registry.html#ae56042d93e16ea2c1e99233fc0451d51">RegisterFunctor</a> (<a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> *functor)</td></tr>
100<tr class="separator:ae56042d93e16ea2c1e99233fc0451d51"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<tr class="memitem:ab421312295ae76edb4a540900d96103b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_registry.html#ab421312295ae76edb4a540900d96103b">GetFunctor</a> (uint32_t familyId, uint32_t packetId, uint32_t version) const</td></tr>
102<tr class="separator:ab421312295ae76edb4a540900d96103b"><td class="memSeparator" colspan="2">&#160;</td></tr>
103</table>
104<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
105<div class="textblock">
106<p class="definition">Definition at line <a class="el" href="_command_handler_registry_8hpp_source.html#l00032">32</a> of file <a class="el" href="_command_handler_registry_8hpp_source.html">CommandHandlerRegistry.hpp</a>.</p>
107</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
108<a id="a46f9edb3e365423b93373629e9a13509"></a>
109<h2 class="memtitle"><span class="permalink"><a href="#a46f9edb3e365423b93373629e9a13509">&#9670;&nbsp;</a></span>CommandHandlerRegistry()</h2>
110
111<div class="memitem">
112<div class="memproto">
113<table class="mlabels">
114 <tr>
115 <td class="mlabels-left">
116 <table class="memname">
117 <tr>
118 <td class="memname"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_registry.html">CommandHandlerRegistry</a> </td>
119 <td>(</td>
120 <td class="paramname"></td><td>)</td>
121 <td></td>
122 </tr>
123 </table>
124 </td>
125 <td class="mlabels-right">
126<span class="mlabels"><span class="mlabel">default</span></span> </td>
127 </tr>
128</table>
129</div><div class="memdoc">
130
131</div>
132</div>
133<h2 class="groupheader">Member Function Documentation</h2>
134<a id="ab421312295ae76edb4a540900d96103b"></a>
135<h2 class="memtitle"><span class="permalink"><a href="#ab421312295ae76edb4a540900d96103b">&#9670;&nbsp;</a></span>GetFunctor()</h2>
136
137<div class="memitem">
138<div class="memproto">
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> * GetFunctor </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> const</td>
162 </tr>
163 </table>
164</div><div class="memdoc">
165
166<p class="definition">Definition at line <a class="el" href="_command_handler_registry_8cpp_source.html#l00035">35</a> of file <a class="el" href="_command_handler_registry_8cpp_source.html">CommandHandlerRegistry.cpp</a>.</p>
167
168<p class="reference">Referenced by <a class="el" href="_profiling_tests_8cpp_source.html#l00377">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_command_handler_8cpp_source.html#l00034">CommandHandler::Stop()</a>.</p>
169<div class="fragment"><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; CommandHandlerKey key(familyId, packetId, version);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// Check that the requested key exists</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">if</span> (registry.find(key) == registry.end())</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a>(</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; boost::str(boost::format(<span class="stringliteral">&quot;Functor with requested PacketId=%1% and Version=%2% does not exist&quot;</span>)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; % packetId</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; % version));</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</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; CommandHandlerFunctor* commandHandlerFunctor = registry.at(key);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">if</span> (commandHandlerFunctor == <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">throw</span> RuntimeException(</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; boost::str(boost::format(<span class="stringliteral">&quot;Invalid functor registered for PacketId=%1% and Version=%2%&quot;</span>)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; % packetId</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; % version));</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">return</span> commandHandlerFunctor;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_invalid_argument_exception_html"><div class="ttname"><a href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00080">Exceptions.hpp:80</a></div></div>
170</div><!-- fragment -->
171</div>
172</div>
173<a id="a7875d60ac5ca76c70f599367ec61261a"></a>
174<h2 class="memtitle"><span class="permalink"><a href="#a7875d60ac5ca76c70f599367ec61261a">&#9670;&nbsp;</a></span>RegisterFunctor() <span class="overload">[1/2]</span></h2>
175
176<div class="memitem">
177<div class="memproto">
178 <table class="memname">
179 <tr>
180 <td class="memname">void RegisterFunctor </td>
181 <td>(</td>
182 <td class="paramtype"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> *&#160;</td>
183 <td class="paramname"><em>functor</em>, </td>
184 </tr>
185 <tr>
186 <td class="paramkey"></td>
187 <td></td>
188 <td class="paramtype">uint32_t&#160;</td>
189 <td class="paramname"><em>familyId</em>, </td>
190 </tr>
191 <tr>
192 <td class="paramkey"></td>
193 <td></td>
194 <td class="paramtype">uint32_t&#160;</td>
195 <td class="paramname"><em>packetId</em>, </td>
196 </tr>
197 <tr>
198 <td class="paramkey"></td>
199 <td></td>
200 <td class="paramtype">uint32_t&#160;</td>
201 <td class="paramname"><em>version</em>&#160;</td>
202 </tr>
203 <tr>
204 <td></td>
205 <td>)</td>
206 <td></td><td></td>
207 </tr>
208 </table>
209</div><div class="memdoc">
210
211<p class="definition">Definition at line <a class="el" href="_command_handler_registry_8cpp_source.html#l00017">17</a> of file <a class="el" href="_command_handler_registry_8cpp_source.html">CommandHandlerRegistry.cpp</a>.</p>
212
213<p class="reference">Referenced by <a class="el" href="_profiling_tests_8cpp_source.html#l00129">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_gatord_mock_main_8cpp_source.html#l00018">main()</a>, <a class="el" href="_profiling_service_8hpp_source.html#l00160">ProfilingService::ProfilingService()</a>, and <a class="el" href="_command_handler_registry_8cpp_source.html#l00028">CommandHandlerRegistry::RegisterFunctor()</a>.</p>
214<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; BOOST_ASSERT_MSG(functor, <span class="stringliteral">&quot;Provided functor should not be a nullptr&quot;</span>);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; CommandHandlerKey key(familyId, packetId, version);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; registry[key] = functor;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;}</div></div><!-- fragment -->
215</div>
216</div>
217<a id="ae56042d93e16ea2c1e99233fc0451d51"></a>
218<h2 class="memtitle"><span class="permalink"><a href="#ae56042d93e16ea2c1e99233fc0451d51">&#9670;&nbsp;</a></span>RegisterFunctor() <span class="overload">[2/2]</span></h2>
219
220<div class="memitem">
221<div class="memproto">
222 <table class="memname">
223 <tr>
224 <td class="memname">void RegisterFunctor </td>
225 <td>(</td>
226 <td class="paramtype"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> *&#160;</td>
227 <td class="paramname"><em>functor</em></td><td>)</td>
228 <td></td>
229 </tr>
230 </table>
231</div><div class="memdoc">
232
233<p class="definition">Definition at line <a class="el" href="_command_handler_registry_8cpp_source.html#l00028">28</a> of file <a class="el" href="_command_handler_registry_8cpp_source.html">CommandHandlerRegistry.cpp</a>.</p>
234
235<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="_command_handler_registry_8cpp_source.html#l00017">CommandHandlerRegistry::RegisterFunctor()</a>.</p>
236<div class="fragment"><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; BOOST_ASSERT_MSG(functor, <span class="stringliteral">&quot;Provided functor should not be a nullptr&quot;</span>);</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; <a class="code" href="classarmnn_1_1profiling_1_1_command_handler_registry.html#a7875d60ac5ca76c70f599367ec61261a">RegisterFunctor</a>(functor, functor-&gt;GetFamilyId(), functor-&gt;GetPacketId(), functor-&gt;GetVersion());</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;}</div><div class="ttc" id="classarmnn_1_1profiling_1_1_command_handler_registry_html_a7875d60ac5ca76c70f599367ec61261a"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_command_handler_registry.html#a7875d60ac5ca76c70f599367ec61261a">armnn::profiling::CommandHandlerRegistry::RegisterFunctor</a></div><div class="ttdeci">void RegisterFunctor(CommandHandlerFunctor *functor, uint32_t familyId, uint32_t packetId, uint32_t version)</div><div class="ttdef"><b>Definition:</b> <a href="_command_handler_registry_8cpp_source.html#l00017">CommandHandlerRegistry.cpp:17</a></div></div>
237</div><!-- fragment -->
238</div>
239</div>
240<hr/>The documentation for this class was generated from the following files:<ul>
241<li>src/profiling/<a class="el" href="_command_handler_registry_8hpp_source.html">CommandHandlerRegistry.hpp</a></li>
242<li>src/profiling/<a class="el" href="_command_handler_registry_8cpp_source.html">CommandHandlerRegistry.cpp</a></li>
243</ul>
244</div><!-- contents -->
245</div><!-- doc-content -->
246<!-- start footer part -->
247<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
248 <ul>
249 <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_registry.html">CommandHandlerRegistry</a></li>
250 <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
251 <a href="http://www.doxygen.org/index.html">
252 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
253 </ul>
254</div>
255</body>
256</html>