diff options
| author | Colm Donelan <Colm.Donelan@arm.com> | 2020-05-20 16:12:19 +0100 |
|---|---|---|
| committer | Colm Donelan <Colm.Donelan@arm.com> | 2020-05-29 10:28:40 +0100 |
| commit | a983e4699082a0b1ef685bab7354f2ad9cd37a44 (patch) | |
| tree | 4fa94e7ab27053461b481cfbdc1b7c17ca475ac6 /20.05/classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml | |
| parent | 764d50a3271dea43a6e9273e6dfd98990281c654 (diff) | |
| download | armnn-a983e4699082a0b1ef685bab7354f2ad9cd37a44.tar.gz | |
Updating Doxygen documentation for 20.05 release.
Change-Id: I4d624343ed5fd6ae269c3d53532903084508fd14
Signed-off-by: Colm Donelan <Colm.Donelan@arm.com>
Diffstat (limited to '20.05/classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml')
| -rw-r--r-- | 20.05/classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml | 277 |
1 files changed, 277 insertions, 0 deletions
diff --git a/20.05/classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml b/20.05/classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml new file mode 100644 index 0000000000..674812be99 --- /dev/null +++ b/20.05/classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml @@ -0,0 +1,277 @@ +<!-- 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: ILocalPacketHandler 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">20.05</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_i_local_packet_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_i_local_packet_handler-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">ILocalPacketHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_i_local_packet_handler_8hpp_source.xhtml">ILocalPacketHandler.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for ILocalPacketHandler:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1profiling_1_1_i_local_packet_handler.png" usemap="#ILocalPacketHandler_map" alt=""/> + <map id="ILocalPacketHandler_map" name="ILocalPacketHandler_map"> +<area href="classarmnn_1_1profiling_1_1_print_packet_header_handler.xhtml" alt="PrintPacketHeaderHandler" shape="rect" coords="0,56,164,80"/> +<area href="classarmnn_1_1profiling_1_1_test_timeline_packet_handler.xhtml" alt="TestTimelinePacketHandler" shape="rect" coords="174,56,338,80"/> +</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:a9bef5ba2e8c6e4a7ca3397a51ad98159"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml#a9bef5ba2e8c6e4a7ca3397a51ad98159">~ILocalPacketHandler</a> ()</td></tr> +<tr class="separator:a9bef5ba2e8c6e4a7ca3397a51ad98159"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a798760e433b8fe7801de8427169004ca"><td class="memItemLeft" align="right" valign="top">virtual std::vector< uint32_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml#a798760e433b8fe7801de8427169004ca">GetHeadersAccepted</a> ()=0</td></tr> +<tr class="separator:a798760e433b8fe7801de8427169004ca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a731e7bb7bbc0f42f4f17cc6d8b207f83"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml#a731e7bb7bbc0f42f4f17cc6d8b207f83">HandlePacket</a> (const Packet &packet)=0</td></tr> +<tr class="memdesc:a731e7bb7bbc0f42f4f17cc6d8b207f83"><td class="mdescLeft"> </td><td class="mdescRight">process the packet <a href="#a731e7bb7bbc0f42f4f17cc6d8b207f83">More...</a><br /></td></tr> +<tr class="separator:a731e7bb7bbc0f42f4f17cc6d8b207f83"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a066dc40fc7610f75aad79c87d2bc6555"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml#a066dc40fc7610f75aad79c87d2bc6555">SetConnection</a> (<a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a> *profilingConnection)</td></tr> +<tr class="memdesc:a066dc40fc7610f75aad79c87d2bc6555"><td class="mdescLeft"> </td><td class="mdescRight">Set a profiling connection on the handler. <a href="#a066dc40fc7610f75aad79c87d2bc6555">More...</a><br /></td></tr> +<tr class="separator:a066dc40fc7610f75aad79c87d2bc6555"><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="_i_local_packet_handler_8hpp_source.xhtml#l00024">24</a> of file <a class="el" href="_i_local_packet_handler_8hpp_source.xhtml">ILocalPacketHandler.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a9bef5ba2e8c6e4a7ca3397a51ad98159"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9bef5ba2e8c6e4a7ca3397a51ad98159">◆ </a></span>~ILocalPacketHandler()</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_i_local_packet_handler.xhtml">ILocalPacketHandler</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="_i_local_packet_handler_8hpp_source.xhtml#l00027">27</a> of file <a class="el" href="_i_local_packet_handler_8hpp_source.xhtml">ILocalPacketHandler.hpp</a>.</p> + +<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml#a798760e433b8fe7801de8427169004ca">ILocalPacketHandler::GetHeadersAccepted()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_local_packet_handler.xhtml#a731e7bb7bbc0f42f4f17cc6d8b207f83">ILocalPacketHandler::HandlePacket()</a>.</p> +<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {};</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a798760e433b8fe7801de8427169004ca"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a798760e433b8fe7801de8427169004ca">◆ </a></span>GetHeadersAccepted()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual std::vector<uint32_t> GetHeadersAccepted </td> + <td>(</td> + <td class="paramname"></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"> +<dl class="section return"><dt>Returns</dt><dd>lists the headers of the packets that this handler accepts only these packets will get sent to this handler. If this function returns an empty list then ALL packets will be sent to the PacketHandler i.e. a universal handler. </dd></dl> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_timeline_packet_handler.xhtml#a0729ebfcf0d2e4717b94f212fac0bc0c">TestTimelinePacketHandler</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_i_local_packet_handler_8hpp_source.xhtml#l00027">ILocalPacketHandler::~ILocalPacketHandler()</a>.</p> + +</div> +</div> +<a id="a731e7bb7bbc0f42f4f17cc6d8b207f83"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a731e7bb7bbc0f42f4f17cc6d8b207f83">◆ </a></span>HandlePacket()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void HandlePacket </td> + <td>(</td> + <td class="paramtype">const 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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>process the packet </p> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_timeline_packet_handler.xhtml#a2d3833345d2ad1283dc3d3b8fca76758">TestTimelinePacketHandler</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_i_local_packet_handler_8hpp_source.xhtml#l00027">ILocalPacketHandler::~ILocalPacketHandler()</a>.</p> + +</div> +</div> +<a id="a066dc40fc7610f75aad79c87d2bc6555"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a066dc40fc7610f75aad79c87d2bc6555">◆ </a></span>SetConnection()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void SetConnection </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a> * </td> + <td class="paramname"><em>profilingConnection</em></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>Set a profiling connection on the handler. </p> +<p>Only need to implement this function if the handler will be writing data back to the profiled application. </p> + +<p>Reimplemented in <a class="el" href="classarmnn_1_1profiling_1_1_test_timeline_packet_handler.xhtml#ade303c171a69f586e5a92a1b9b15d596">TestTimelinePacketHandler</a>.</p> + +<p class="definition">Definition at line <a class="el" href="_i_local_packet_handler_8hpp_source.xhtml#l00040">40</a> of file <a class="el" href="_i_local_packet_handler_8hpp_source.xhtml">ILocalPacketHandler.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.xhtml#l00014">armnn::IgnoreUnused()</a>.</p> +<div class="fragment"><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {<a class="code" href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a>(profilingConnection);}</div><div class="ttc" id="namespacearmnn_xhtml_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a></div><div class="ttdeci">void IgnoreUnused(Ts &&...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.xhtml#l00014">IgnoreUnused.hpp:14</a></div></div> +</div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/armnn/profiling/<a class="el" href="_i_local_packet_handler_8hpp_source.xhtml">ILocalPacketHandler.hpp</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_i_local_packet_handler.xhtml">ILocalPacketHandler</a></li> + <li class="footer">Generated on Fri May 29 2020 10:20:55 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> |