diff options
| author | Jan Eilers <jan.eilers@arm.com> | 2021-02-25 17:44:00 +0000 |
|---|---|---|
| committer | Jan Eilers <jan.eilers@arm.com> | 2021-02-25 18:27:49 +0000 |
| commit | fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf (patch) | |
| tree | eb4bc8f9b411f30c7655616142b5a4bdd3a1acd0 /21.02/classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml | |
| parent | fb14ebbd68e04876809145296af96f6f41857418 (diff) | |
| download | armnn-fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf.tar.gz | |
IVGCVSW-5687 Update Doxygen Docu
* Update Doxygen Documentation for 21.02 release
Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5
Diffstat (limited to '21.02/classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml')
| -rw-r--r-- | 21.02/classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml | 323 |
1 files changed, 323 insertions, 0 deletions
diff --git a/21.02/classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml b/21.02/classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml new file mode 100644 index 0000000000..f846a79c06 --- /dev/null +++ b/21.02/classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml @@ -0,0 +1,323 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!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="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: DirectoryCaptureCommandHandler 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> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.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;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">21.02</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_directory_capture_command_handler.xhtml','');}); +</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_1profiling_1_1_directory_capture_command_handler-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">DirectoryCaptureCommandHandler Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml">DirectoryCaptureCommandHandler.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for DirectoryCaptureCommandHandler:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1profiling_1_1_directory_capture_command_handler.png" usemap="#DirectoryCaptureCommandHandler_map" alt=""/> + <map id="DirectoryCaptureCommandHandler_map" name="DirectoryCaptureCommandHandler_map"> +</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:a439df5e87f9c6e2bb674d0ddf9ccc07e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml#a439df5e87f9c6e2bb674d0ddf9ccc07e">DirectoryCaptureCommandHandler</a> (uint32_t familyId, uint32_t packetId, uint32_t version, bool quietOperation=<a class="el" href="_ref_layer_tests_8cpp.xhtml#a88d84cc49602ca19491dea9c998035fe">true</a>)</td></tr> +<tr class="separator:a439df5e87f9c6e2bb674d0ddf9ccc07e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7f194544050d3b16f7363a93a234b89c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml#a7f194544050d3b16f7363a93a234b89c">operator()</a> (const arm::pipe::Packet &packet) override</td></tr> +<tr class="separator:a7f194544050d3b16f7363a93a234b89c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adfaa32654e05eab63b2adc34b2138475"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_directory.xhtml">ICounterDirectory</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml#adfaa32654e05eab63b2adc34b2138475">GetCounterDirectory</a> () const</td></tr> +<tr class="separator:adfaa32654e05eab63b2adc34b2138475"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7877b37f88f6d9d8743b492a2970c837"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml#a7877b37f88f6d9d8743b492a2970c837">ParsedCounterDirectory</a> ()</td></tr> +<tr class="separator:a7877b37f88f6d9d8743b492a2970c837"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a41a25ce1deeb5ac0ddbaa99bba961dc6"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml#a41a25ce1deeb5ac0ddbaa99bba961dc6">TranslateUIDCopyToOriginal</a> (uint16_t copyUid)</td></tr> +<tr class="memdesc:a41a25ce1deeb5ac0ddbaa99bba961dc6"><td class="mdescLeft"> </td><td class="mdescRight">Given a Uid that came from a copy of the counter directory translate it to the original. <a href="#a41a25ce1deeb5ac0ddbaa99bba961dc6">More...</a><br /></td></tr> +<tr class="separator:a41a25ce1deeb5ac0ddbaa99bba961dc6"><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="_directory_capture_command_handler_8hpp_source.xhtml#l00034">34</a> of file <a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml">DirectoryCaptureCommandHandler.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a439df5e87f9c6e2bb674d0ddf9ccc07e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a439df5e87f9c6e2bb674d0ddf9ccc07e">◆ </a></span>DirectoryCaptureCommandHandler()</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_directory_capture_command_handler.xhtml">DirectoryCaptureCommandHandler</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.xhtml#a88d84cc49602ca19491dea9c998035fe">true</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"> + +<p class="definition">Definition at line <a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml#l00038">38</a> of file <a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml">DirectoryCaptureCommandHandler.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  : CommandHandlerFunctor(familyId, packetId, version)</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  , m_QuietOperation(quietOperation)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  , m_AlreadyParsed(<span class="keyword">false</span>)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="adfaa32654e05eab63b2adc34b2138475"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adfaa32654e05eab63b2adc34b2138475">◆ </a></span>GetCounterDirectory()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_directory.xhtml">ICounterDirectory</a> & GetCounterDirectory </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="_directory_capture_command_handler_8cpp_source.xhtml#l00320">320</a> of file <a class="el" href="_directory_capture_command_handler_8cpp_source.xhtml">DirectoryCaptureCommandHandler.cpp</a>.</p> + +<p class="reference">References <a class="el" href="_profiling_utils_8cpp_source.xhtml#l00195">armnn::profiling::ReadUint8()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_gatord_mock_tests_8cpp_source.xhtml#l00239">BOOST_AUTO_TEST_CASE()</a>.</p> +<div class="fragment"><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> {</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <span class="keywordflow">return</span> m_CounterDirectory;</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a7f194544050d3b16f7363a93a234b89c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7f194544050d3b16f7363a93a234b89c">◆ </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 arm::pipe::Packet & </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> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_directory_capture_command_handler_8cpp_source.xhtml#l00300">300</a> of file <a class="el" href="_directory_capture_command_handler_8cpp_source.xhtml">DirectoryCaptureCommandHandler.cpp</a>.</p> + +<p class="reference">References <a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml#l00048">DirectoryCaptureCommandHandler::ParsedCounterDirectory()</a>, and <a class="el" href="_profiling_utils_8cpp_source.xhtml#l00857">armnn::profiling::PrintCounterDirectory()</a>.</p> +<div class="fragment"><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> {</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="keywordflow">if</span> (!m_QuietOperation) <span class="comment">// Are we supposed to print to stdout?</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  {</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  std::cout << <span class="stringliteral">"Counter directory packet received."</span> << std::endl;</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  }</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> </div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="comment">// The ArmNN counter directory is static per ArmNN instance. Ensure we don't parse it a second time.</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keywordflow">if</span> (!<a class="code" href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml#a7877b37f88f6d9d8743b492a2970c837">ParsedCounterDirectory</a>())</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  {</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  ParseData(packet);</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  m_AlreadyParsed = <span class="keyword">true</span>;</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  }</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> </div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="keywordflow">if</span> (!m_QuietOperation)</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  {</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <a class="code" href="namespacearmnn_1_1profiling.xhtml#a02f98a63d0ef3a10bb359c3ac525f330">armnn::profiling::PrintCounterDirectory</a>(m_CounterDirectory);</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  }</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> }</div><div class="ttc" id="classarmnn_1_1profiling_1_1_directory_capture_command_handler_xhtml_a7877b37f88f6d9d8743b492a2970c837"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml#a7877b37f88f6d9d8743b492a2970c837">armnn::profiling::DirectoryCaptureCommandHandler::ParsedCounterDirectory</a></div><div class="ttdeci">bool ParsedCounterDirectory()</div><div class="ttdef"><b>Definition:</b> <a href="_directory_capture_command_handler_8hpp_source.xhtml#l00048">DirectoryCaptureCommandHandler.hpp:48</a></div></div> +<div class="ttc" id="namespacearmnn_1_1profiling_xhtml_a02f98a63d0ef3a10bb359c3ac525f330"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#a02f98a63d0ef3a10bb359c3ac525f330">armnn::profiling::PrintCounterDirectory</a></div><div class="ttdeci">void PrintCounterDirectory(ICounterDirectory &counterDirectory)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_utils_8cpp_source.xhtml#l00857">ProfilingUtils.cpp:857</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a7877b37f88f6d9d8743b492a2970c837"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7877b37f88f6d9d8743b492a2970c837">◆ </a></span>ParsedCounterDirectory()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool ParsedCounterDirectory </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> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml#l00048">48</a> of file <a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml">DirectoryCaptureCommandHandler.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_gatord_mock_tests_8cpp_source.xhtml#l00239">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_directory_capture_command_handler_8cpp_source.xhtml#l00300">DirectoryCaptureCommandHandler::operator()()</a>.</p> +<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> m_AlreadyParsed.load();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div></div><!-- fragment --> +</div> +</div> +<a id="a41a25ce1deeb5ac0ddbaa99bba961dc6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a41a25ce1deeb5ac0ddbaa99bba961dc6">◆ </a></span>TranslateUIDCopyToOriginal()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">uint16_t TranslateUIDCopyToOriginal </td> + <td>(</td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>copyUid</em></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>Given a Uid that came from a copy of the counter directory translate it to the original. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">copyUid</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the original Uid that the copy maps to. </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml#l00059">59</a> of file <a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml">DirectoryCaptureCommandHandler.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_gatord_mock_tests_8cpp_source.xhtml#l00239">BOOST_AUTO_TEST_CASE()</a>.</p> +<div class="fragment"><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> m_UidTranslation[copyUid];</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div></div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>src/profiling/<a class="el" href="_directory_capture_command_handler_8hpp_source.xhtml">DirectoryCaptureCommandHandler.hpp</a></li> +<li>src/profiling/<a class="el" href="_directory_capture_command_handler_8cpp_source.xhtml">DirectoryCaptureCommandHandler.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.xhtml">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.xhtml">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_directory_capture_command_handler.xhtml">DirectoryCaptureCommandHandler</a></li> + <li class="footer">Generated on Thu Feb 25 2021 17:28:02 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> |