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_per_job_counter_selection_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_per_job_counter_selection_command_handler.xhtml')
-rw-r--r-- | 21.02/classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.xhtml | 236 |
1 files changed, 236 insertions, 0 deletions
diff --git a/21.02/classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.xhtml b/21.02/classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.xhtml new file mode 100644 index 0000000000..6c74c1e0f3 --- /dev/null +++ b/21.02/classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.xhtml @@ -0,0 +1,236 @@ +<!-- 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: PerJobCounterSelectionCommandHandler 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_per_job_counter_selection_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_per_job_counter_selection_command_handler-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">PerJobCounterSelectionCommandHandler Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_per_job_counter_selection_command_handler_8hpp_source.xhtml">PerJobCounterSelectionCommandHandler.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for PerJobCounterSelectionCommandHandler:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.png" usemap="#PerJobCounterSelectionCommandHandler_map" alt=""/> + <map id="PerJobCounterSelectionCommandHandler_map" name="PerJobCounterSelectionCommandHandler_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:a886fe3802815764dc28d7d96d0dbc8d4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_per_job_counter_selection_command_handler.xhtml#a886fe3802815764dc28d7d96d0dbc8d4">PerJobCounterSelectionCommandHandler</a> (uint32_t familyId, uint32_t packetId, uint32_t version, const <a class="el" href="classarmnn_1_1profiling_1_1_profiling_state_machine.xhtml">ProfilingStateMachine</a> &profilingStateMachine)</td></tr> +<tr class="separator:a886fe3802815764dc28d7d96d0dbc8d4"><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_per_job_counter_selection_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> +</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="_per_job_counter_selection_command_handler_8hpp_source.xhtml#l00019">19</a> of file <a class="el" href="_per_job_counter_selection_command_handler_8hpp_source.xhtml">PerJobCounterSelectionCommandHandler.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a886fe3802815764dc28d7d96d0dbc8d4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a886fe3802815764dc28d7d96d0dbc8d4">◆ </a></span>PerJobCounterSelectionCommandHandler()</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_per_job_counter_selection_command_handler.xhtml">PerJobCounterSelectionCommandHandler</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">const <a class="el" href="classarmnn_1_1profiling_1_1_profiling_state_machine.xhtml">ProfilingStateMachine</a> & </td> + <td class="paramname"><em>profilingStateMachine</em> </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="_per_job_counter_selection_command_handler_8hpp_source.xhtml#l00023">23</a> of file <a class="el" href="_per_job_counter_selection_command_handler_8hpp_source.xhtml">PerJobCounterSelectionCommandHandler.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_per_job_counter_selection_command_handler_8cpp_source.xhtml#l00017">PerJobCounterSelectionCommandHandler::operator()()</a>.</p> +<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  : CommandHandlerFunctor(familyId, packetId, version)</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  , m_StateMachine(profilingStateMachine)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<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="_per_job_counter_selection_command_handler_8cpp_source.xhtml#l00017">17</a> of file <a class="el" href="_per_job_counter_selection_command_handler_8cpp_source.xhtml">PerJobCounterSelectionCommandHandler.cpp</a>.</p> + +<p class="reference">References <a class="el" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a4d3d769b812b6faa6b76e1a8abaece2d">armnn::profiling::Active</a>, <a class="el" href="_profiling_state_machine_8cpp_source.xhtml#l00031">ProfilingStateMachine::GetCurrentState()</a>, <a class="el" href="_profiling_state_machine_8hpp_source.xhtml#l00059">armnn::profiling::GetProfilingStateName()</a>, <a class="el" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a4075072d219e061ca0f3124f8fbef463">armnn::profiling::NotConnected</a>, <a class="el" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a962074a9de1cf3d6d7b6f955a0a94820">armnn::profiling::Uninitialised</a>, and <a class="el" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a1dc1edc76d5b3c0325f00002f4c841f5">armnn::profiling::WaitingForAck</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_per_job_counter_selection_command_handler_8hpp_source.xhtml#l00023">PerJobCounterSelectionCommandHandler::PerJobCounterSelectionCommandHandler()</a>.</p> +<div class="fragment"><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <a class="code" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806">ProfilingState</a> currentState = m_StateMachine.<a class="code" href="classarmnn_1_1profiling_1_1_profiling_state_machine.xhtml#ad8d263669817cf577760710ff6c96bb9">GetCurrentState</a>();</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordflow">switch</span> (currentState)</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordflow">case</span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a962074a9de1cf3d6d7b6f955a0a94820">ProfilingState::Uninitialised</a>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">case</span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a4075072d219e061ca0f3124f8fbef463">ProfilingState::NotConnected</a>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordflow">case</span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a1dc1edc76d5b3c0325f00002f4c841f5">ProfilingState::WaitingForAck</a>:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(fmt::format(</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="stringliteral">"Per-Job Counter Selection Command Handler invoked while in an incorrect state: {}"</span>,</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="namespacearmnn_1_1profiling.xhtml#aa6851e58c103f77fcf83b722b4b81e9d">GetProfilingStateName</a>(currentState)));</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">case</span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a4d3d769b812b6faa6b76e1a8abaece2d">ProfilingState::Active</a>:</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// Process the packet</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">if</span> (!(packet.GetPacketFamily() == 0u && packet.GetPacketId() == 5u))</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>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_invalid_argument_exception.xhtml">armnn::InvalidArgumentException</a>(fmt::format(<span class="stringliteral">"Expected Packet family = 0, id = 5 but "</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="stringliteral">"received family = {}, id = {}"</span>,</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  packet.GetPacketFamily(),</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  packet.GetPacketId()));</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// Silently drop the packet</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(fmt::format(<span class="stringliteral">"Unknown profiling service state: {}"</span>,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  static_cast<int>(currentState)));</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> }</div><div class="ttc" id="classarmnn_1_1profiling_1_1_profiling_state_machine_xhtml_ad8d263669817cf577760710ff6c96bb9"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_profiling_state_machine.xhtml#ad8d263669817cf577760710ff6c96bb9">armnn::profiling::ProfilingStateMachine::GetCurrentState</a></div><div class="ttdeci">ProfilingState GetCurrentState() const</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_state_machine_8cpp_source.xhtml#l00031">ProfilingStateMachine.cpp:31</a></div></div> +<div class="ttc" id="namespacearmnn_1_1profiling_xhtml_acb0c054138599582d5a5f537e9798806a4075072d219e061ca0f3124f8fbef463"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a4075072d219e061ca0f3124f8fbef463">armnn::profiling::ProfilingState::NotConnected</a></div></div> +<div class="ttc" id="namespacearmnn_1_1profiling_xhtml_acb0c054138599582d5a5f537e9798806a4d3d769b812b6faa6b76e1a8abaece2d"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a4d3d769b812b6faa6b76e1a8abaece2d">armnn::profiling::ProfilingState::Active</a></div></div> +<div class="ttc" id="classarmnn_1_1_runtime_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00120">Exceptions.hpp:120</a></div></div> +<div class="ttc" id="classarmnn_1_1_invalid_argument_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_invalid_argument_exception.xhtml">armnn::InvalidArgumentException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00080">Exceptions.hpp:80</a></div></div> +<div class="ttc" id="namespacearmnn_1_1profiling_xhtml_acb0c054138599582d5a5f537e9798806a1dc1edc76d5b3c0325f00002f4c841f5"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a1dc1edc76d5b3c0325f00002f4c841f5">armnn::profiling::ProfilingState::WaitingForAck</a></div></div> +<div class="ttc" id="namespacearmnn_1_1profiling_xhtml_acb0c054138599582d5a5f537e9798806a962074a9de1cf3d6d7b6f955a0a94820"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806a962074a9de1cf3d6d7b6f955a0a94820">armnn::profiling::ProfilingState::Uninitialised</a></div></div> +<div class="ttc" id="namespacearmnn_1_1profiling_xhtml_acb0c054138599582d5a5f537e9798806"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#acb0c054138599582d5a5f537e9798806">armnn::profiling::ProfilingState</a></div><div class="ttdeci">ProfilingState</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_state_machine_8hpp_source.xhtml#l00018">ProfilingStateMachine.hpp:18</a></div></div> +<div class="ttc" id="namespacearmnn_1_1profiling_xhtml_aa6851e58c103f77fcf83b722b4b81e9d"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#aa6851e58c103f77fcf83b722b4b81e9d">armnn::profiling::GetProfilingStateName</a></div><div class="ttdeci">constexpr char const * GetProfilingStateName(ProfilingState state)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_state_machine_8hpp_source.xhtml#l00059">ProfilingStateMachine.hpp:59</a></div></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="_per_job_counter_selection_command_handler_8hpp_source.xhtml">PerJobCounterSelectionCommandHandler.hpp</a></li> +<li>src/profiling/<a class="el" href="_per_job_counter_selection_command_handler_8cpp_source.xhtml">PerJobCounterSelectionCommandHandler.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_per_job_counter_selection_command_handler.xhtml">PerJobCounterSelectionCommandHandler</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> |