diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html')
-rw-r--r-- | Documentation/classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html b/Documentation/classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html new file mode 100644 index 0000000000..4396411a4c --- /dev/null +++ b/Documentation/classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html @@ -0,0 +1,231 @@ +<!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: StreamMetadataCommandHandler 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 +  <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_1gatordmock_1_1_stream_metadata_command_handler.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> | +<a href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">StreamMetadataCommandHandler Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_stream_metadata_command_handler_8hpp_source.html">StreamMetadataCommandHandler.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for StreamMetadataCommandHandler:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.png" usemap="#StreamMetadataCommandHandler_map" alt=""/> + <map id="StreamMetadataCommandHandler_map" name="StreamMetadataCommandHandler_map"> +<area href="classarmnn_1_1profiling_1_1_command_handler_functor.html" alt="CommandHandlerFunctor" shape="rect" coords="0,0,203,24"/> +</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:aa12cf392e67cb07069c9ed2b45d504d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html#aa12cf392e67cb07069c9ed2b45d504d9">StreamMetadataCommandHandler</a> (uint32_t familyId, uint32_t packetId, uint32_t version, bool quietOperation=<a class="el" href="_ref_layer_tests_8cpp.html#a67e2647a90dec71bb79c8b38872ba570">false</a>)</td></tr> +<tr class="separator:aa12cf392e67cb07069c9ed2b45d504d9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7ea1ce1121a51bbea9ea973c3a1463bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html#a7ea1ce1121a51bbea9ea973c3a1463bb">operator()</a> (const <a class="el" href="classarmnn_1_1profiling_1_1_packet.html">armnn::profiling::Packet</a> &packet) override</td></tr> +<tr class="separator:a7ea1ce1121a51bbea9ea973c3a1463bb"><td class="memSeparator" colspan="2"> </td></tr> +<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="-"/> Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html">CommandHandlerFunctor</a></td></tr> +<tr class="memitem:ad88cf21899e5a0ee2d803eabf3f5dd04 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memItemLeft" align="right" valign="top"> </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 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a52df705001d502e24a079bd8e0c1e956 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memItemLeft" align="right" valign="top">uint32_t </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 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a17b980d48f35a31c27a227e8ceae5402 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memItemLeft" align="right" valign="top">uint32_t </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 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7a9568e40773e80ab38c1a7dac4e7089 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memItemLeft" align="right" valign="top">uint32_t </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 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a05aaf089b3b02e13bc728e2c8c94cb4e inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memItemLeft" align="right" valign="top">virtual </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 inherit pub_methods_classarmnn_1_1profiling_1_1_command_handler_functor"><td class="memSeparator" colspan="2"> </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="_stream_metadata_command_handler_8hpp_source.html#l00026">26</a> of file <a class="el" href="_stream_metadata_command_handler_8hpp_source.html">StreamMetadataCommandHandler.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="aa12cf392e67cb07069c9ed2b45d504d9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa12cf392e67cb07069c9ed2b45d504d9">◆ </a></span>StreamMetadataCommandHandler()</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_1gatordmock_1_1_stream_metadata_command_handler.html">StreamMetadataCommandHandler</a> </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>familyId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>packetId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>version</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>quietOperation</em> = <code><a class="el" href="_ref_layer_tests_8cpp.html#a67e2647a90dec71bb79c8b38872ba570">false</a></code> </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"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">familyId</td><td>The family of the packets this handler will service </td></tr> + <tr><td class="paramname">packetId</td><td>The id of packets this handler will process </td></tr> + <tr><td class="paramname">version</td><td>The version of that id </td></tr> + <tr><td class="paramname">quietOperation</td><td><a class="el" href="classarmnn_1_1_optional.html">Optional</a> parameter to turn off printouts. This is useful for unit tests </td></tr> + </table> + </dd> +</dl> + +<p class="definition">Definition at line <a class="el" href="_stream_metadata_command_handler_8hpp_source.html#l00036">36</a> of file <a class="el" href="_stream_metadata_command_handler_8hpp_source.html">StreamMetadataCommandHandler.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  : <a class="code" href="classarmnn_1_1profiling_1_1_command_handler_functor.html#ad88cf21899e5a0ee2d803eabf3f5dd04">CommandHandlerFunctor</a>(familyId, packetId, version)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  , m_QuietOperation(quietOperation)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  {}</div><div class="ttc" id="classarmnn_1_1profiling_1_1_command_handler_functor_html_ad88cf21899e5a0ee2d803eabf3f5dd04"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_command_handler_functor.html#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.html#l00023">CommandHandlerFunctor.hpp:23</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a7ea1ce1121a51bbea9ea973c3a1463bb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7ea1ce1121a51bbea9ea973c3a1463bb">◆ </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">void operator() </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_packet.html">armnn::profiling::Packet</a> & </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">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_command_handler_functor.html#aee5d34e255ea616c6b4d6877eb3c9fad">CommandHandlerFunctor</a>.</p> + +<p class="definition">Definition at line <a class="el" href="_stream_metadata_command_handler_8cpp_source.html#l00023">23</a> of file <a class="el" href="_stream_metadata_command_handler_8cpp_source.html">StreamMetadataCommandHandler.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  ParseData(packet);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">if</span> (m_QuietOperation)</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  }</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  std::stringstream ss;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  ss << <span class="stringliteral">"Stream metadata packet received"</span> << std::endl << std::endl;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  ss << <span class="stringliteral">"Pipe magic: "</span> << m_PipeMagic << std::endl;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  ss << <span class="stringliteral">"Stream metadata version: "</span> << m_StreamMetadataVersion << std::endl;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  ss << <span class="stringliteral">"Max data len: "</span> << m_MaxDataLen << std::endl;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  ss << <span class="stringliteral">"Pid: "</span> << m_Pid << std::endl;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  ss << <span class="stringliteral">"Software info: "</span> << m_SoftwareInfo << std::endl;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  ss << <span class="stringliteral">"Hardware version: "</span> << m_HardwareVersion << std::endl;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  ss << <span class="stringliteral">"Software version: "</span> << m_SoftwareVersion << std::endl;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  ss << <span class="stringliteral">"Process name: "</span> << m_ProcessName << std::endl;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  ss << <span class="stringliteral">"Packet versions: "</span> << m_PacketVersionTable.size() << std::endl;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& packetVersion : m_PacketVersionTable)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  ss << <span class="stringliteral">"-----------------------"</span> << std::endl;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  ss << <span class="stringliteral">"Packet family: "</span> << packetVersion.m_PacketFamily << std::endl;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  ss << <span class="stringliteral">"Packet id: "</span> << packetVersion.m_PacketId << std::endl;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ss << <span class="stringliteral">"Packet version: "</span> << packetVersion.m_PacketVersion << std::endl;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  std::cout << ss.str() << std::endl;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div></div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>tests/profiling/gatordmock/<a class="el" href="_stream_metadata_command_handler_8hpp_source.html">StreamMetadataCommandHandler.hpp</a></li> +<li>tests/profiling/gatordmock/<a class="el" href="_stream_metadata_command_handler_8cpp_source.html">StreamMetadataCommandHandler.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_1gatordmock.html">gatordmock</a></li><li class="navelem"><a class="el" href="classarmnn_1_1gatordmock_1_1_stream_metadata_command_handler.html">StreamMetadataCommandHandler</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:05 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> |