blob: bd68e0628eea5c8ae6c2d5c9176ed3585b543ef8 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: CommandHandlerFunctor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ArmNN
&#160;<span id="projectnumber">NotReleased</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_command_handler_functor.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classarmnn_1_1profiling_1_1_command_handler_functor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CommandHandlerFunctor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_command_handler_functor_8hpp_source.html">CommandHandlerFunctor.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CommandHandlerFunctor:</div>
<div class="dyncontent">
<div class="center">
<img src="classarmnn_1_1profiling_1_1_command_handler_functor.png" usemap="#CommandHandlerFunctor_map" alt=""/>
<map id="CommandHandlerFunctor_map" name="CommandHandlerFunctor_map">
<area href="classarmnn_1_1gatordmock_1_1_periodic_counter_capture_command_handler.html" alt="PeriodicCounterCaptureCommandHandler" shape="rect" coords="269,56,528,80"/>
<area href="classarmnn_1_1gatordmock_1_1_periodic_counter_selection_response_handler.html" alt="PeriodicCounterSelectionResponseHandler" shape="rect" coords="269,112,528,136"/>
<area href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html" alt="StreamMetadataCommandHandler" shape="rect" coords="269,168,528,192"/>
<area href="classarmnn_1_1gatordmock_1_1_timeline_capture_command_handler.html" alt="TimelineCaptureCommandHandler" shape="rect" coords="269,224,528,248"/>
<area href="classarmnn_1_1gatordmock_1_1_timeline_directory_capture_command_handler.html" alt="TimelineDirectoryCaptureCommandHandler" shape="rect" coords="269,280,528,304"/>
<area href="classarmnn_1_1profiling_1_1_connection_acknowledged_command_handler.html" alt="ConnectionAcknowledgedCommandHandler" shape="rect" coords="269,336,528,360"/>
<area href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.html" alt="DirectoryCaptureCommandHandler" shape="rect" coords="269,392,528,416"/>
<area href="classarmnn_1_1profiling_1_1_periodic_counter_selection_command_handler.html" alt="PeriodicCounterSelectionCommandHandler" shape="rect" coords="269,448,528,472"/>
<area href="classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.html" alt="PerJobCounterSelectionCommandHandler" shape="rect" coords="269,504,528,528"/>
<area href="classarmnn_1_1profiling_1_1_request_counter_directory_command_handler.html" alt="RequestCounterDirectoryCommandHandler" shape="rect" coords="269,560,528,584"/>
<area href="classarmnn_1_1profiling_1_1_test_functor_a.html" alt="TestFunctorA" shape="rect" coords="269,616,528,640"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<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>
<tr class="separator:ad88cf21899e5a0ee2d803eabf3f5dd04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a52df705001d502e24a079bd8e0c1e956"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a17b980d48f35a31c27a227e8ceae5402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a7a9568e40773e80ab38c1a7dac4e7089"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aee5d34e255ea616c6b4d6877eb3c9fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a05aaf089b3b02e13bc728e2c8c94cb4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<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>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad88cf21899e5a0ee2d803eabf3f5dd04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad88cf21899e5a0ee2d803eabf3f5dd04">&#9670;&nbsp;</a></span>CommandHandlerFunctor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>familyId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>packetId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>version</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<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>
<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>
<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 -->
</div>
</div>
<a id="a05aaf089b3b02e13bc728e2c8c94cb4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05aaf089b3b02e13bc728e2c8c94cb4e">&#9670;&nbsp;</a></span>~CommandHandlerFunctor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<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>
<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{}</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a52df705001d502e24a079bd8e0c1e956"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52df705001d502e24a079bd8e0c1e956">&#9670;&nbsp;</a></span>GetFamilyId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t GetFamilyId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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>
<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>
<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 -->
</div>
</div>
<a id="a17b980d48f35a31c27a227e8ceae5402"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17b980d48f35a31c27a227e8ceae5402">&#9670;&nbsp;</a></span>GetPacketId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t GetPacketId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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>
<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>
<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 -->
</div>
</div>
<a id="a7a9568e40773e80ab38c1a7dac4e7089"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a9568e40773e80ab38c1a7dac4e7089">&#9670;&nbsp;</a></span>GetVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t GetVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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>
<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>
<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 -->
</div>
</div>
<a id="aee5d34e255ea616c6b4d6877eb3c9fad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee5d34e255ea616c6b4d6877eb3c9fad">&#9670;&nbsp;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_packet.html">Packet</a> &amp;&#160;</td>
<td class="paramname"><em>packet</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<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>
<p class="reference">Referenced by <a class="el" href="_command_handler_functor_8hpp_source.html#l00023">CommandHandlerFunctor::CommandHandlerFunctor()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/profiling/<a class="el" href="_command_handler_functor_8hpp_source.html">CommandHandlerFunctor.hpp</a></li>
<li>src/profiling/<a class="el" href="_command_handler_functor_8cpp_source.html">CommandHandlerFunctor.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
<li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>