diff options
author | Nikhil Raj <nikhil.raj@arm.com> | 2022-08-19 15:23:36 +0100 |
---|---|---|
committer | Nikhil Raj <nikhil.raj@arm.com> | 2022-08-19 15:23:36 +0100 |
commit | 7bfd38a721360183f3392f9ab35db18a0dd7fef8 (patch) | |
tree | 5b4da2f2e88636c939afbafa2571170297114e40 /22.08/classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml | |
parent | d5d43d82c0137e08553e44345c609cdd1a7931c7 (diff) | |
download | armnn-7bfd38a721360183f3392f9ab35db18a0dd7fef8.tar.gz |
Update Doxygen for 22.08 Release
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I4789fe868e0492839be1482e5cee3642ed90d756
Diffstat (limited to '22.08/classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml')
-rw-r--r-- | 22.08/classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml | 354 |
1 files changed, 354 insertions, 0 deletions
diff --git a/22.08/classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml b/22.08/classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml new file mode 100644 index 0000000000..64cdec1cf4 --- /dev/null +++ b/22.08/classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml @@ -0,0 +1,354 @@ +<!-- 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: TestProfilingConnectionBase 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">22.08</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('classarm_1_1pipe_1_1_test_profiling_connection_base.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="#pub-attribs">Public Attributes</a> | +<a href="classarm_1_1pipe_1_1_test_profiling_connection_base-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TestProfilingConnectionBase Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for TestProfilingConnectionBase:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarm_1_1pipe_1_1_test_profiling_connection_base.png" usemap="#TestProfilingConnectionBase_map" alt=""/> + <map id="TestProfilingConnectionBase_map" name="TestProfilingConnectionBase_map"> +<area href="classarm_1_1pipe_1_1_test_profiling_connection_armnn_error.xhtml" alt="TestProfilingConnectionArmnnError" shape="rect" coords="0,112,228,136"/> +<area href="classarm_1_1pipe_1_1_test_profiling_connection_bad_ack_packet.xhtml" alt="TestProfilingConnectionBadAckPacket" shape="rect" coords="238,112,466,136"/> +<area href="classarm_1_1pipe_1_1_test_profiling_connection_timeout_error.xhtml" alt="TestProfilingConnectionTimeoutError" shape="rect" coords="476,112,704,136"/> +</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:abfb705bcb10894813d612267dcb1be70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#abfb705bcb10894813d612267dcb1be70">TestProfilingConnectionBase</a> ()=default</td></tr> +<tr class="separator:abfb705bcb10894813d612267dcb1be70"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aab93b740524e1d31882e71eab460cbc2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#aab93b740524e1d31882e71eab460cbc2">~TestProfilingConnectionBase</a> ()=default</td></tr> +<tr class="separator:aab93b740524e1d31882e71eab460cbc2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a91bdc9d5497d47f5d707418beb83b140"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#a91bdc9d5497d47f5d707418beb83b140">IsOpen</a> () const override</td></tr> +<tr class="separator:a91bdc9d5497d47f5d707418beb83b140"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0f9aecd570c4e5e6d41337f0e2f1adf5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#a0f9aecd570c4e5e6d41337f0e2f1adf5">Close</a> () override</td></tr> +<tr class="separator:a0f9aecd570c4e5e6d41337f0e2f1adf5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a42eb542b5a1d73d00c4ce474140bb78c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#a42eb542b5a1d73d00c4ce474140bb78c">WritePacket</a> (const unsigned char *buffer, uint32_t length) override</td></tr> +<tr class="separator:a42eb542b5a1d73d00c4ce474140bb78c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a47c113357d105d4f7a549a058e5661ab"><td class="memItemLeft" align="right" valign="top">arm::pipe::Packet </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#a47c113357d105d4f7a549a058e5661ab">ReadPacket</a> (uint32_t timeout) override</td></tr> +<tr class="separator:a47c113357d105d4f7a549a058e5661ab"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a4d3bb34842f24c4f16e09dad7fee71e8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#a4d3bb34842f24c4f16e09dad7fee71e8">m_FirstCall</a> = true</td></tr> +<tr class="separator:a4d3bb34842f24c4f16e09dad7fee71e8"><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="_profiling_tests_8hpp_source.xhtml#l00031">31</a> of file <a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="abfb705bcb10894813d612267dcb1be70"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abfb705bcb10894813d612267dcb1be70">◆ </a></span>TestProfilingConnectionBase()</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="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml">TestProfilingConnectionBase</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">default</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="aab93b740524e1d31882e71eab460cbc2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aab93b740524e1d31882e71eab460cbc2">◆ </a></span>~TestProfilingConnectionBase()</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="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml">TestProfilingConnectionBase</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">default</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a0f9aecd570c4e5e6d41337f0e2f1adf5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0f9aecd570c4e5e6d41337f0e2f1adf5">◆ </a></span>Close()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void Close </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">override</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00039">39</a> of file <a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {}</div></div><!-- fragment --> +</div> +</div> +<a id="a91bdc9d5497d47f5d707418beb83b140"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a91bdc9d5497d47f5d707418beb83b140">◆ </a></span>IsOpen()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool IsOpen </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00037">37</a> of file <a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> { <span class="keywordflow">return</span> <span class="keyword">true</span>; }</div></div><!-- fragment --> +</div> +</div> +<a id="a47c113357d105d4f7a549a058e5661ab"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a47c113357d105d4f7a549a058e5661ab">◆ </a></span>ReadPacket()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">arm::pipe::Packet ReadPacket </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeout</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00048">48</a> of file <a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00064">TestProfilingConnectionBase::m_FirstCall</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="comment">// First time we're called return a connection ack packet. After that always timeout.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">if</span> (<a class="code" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#a4d3bb34842f24c4f16e09dad7fee71e8">m_FirstCall</a>)</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>  <a class="code" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#a4d3bb34842f24c4f16e09dad7fee71e8">m_FirstCall</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Return connection acknowledged packet</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">return</span> arm::pipe::Packet(65536);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::this_thread::sleep_for(std::chrono::milliseconds(timeout));</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">throw</span> arm::pipe::TimeoutException(<span class="stringliteral">"Simulate a timeout error\n"</span>);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div><div class="ttc" id="classarm_1_1pipe_1_1_test_profiling_connection_base_xhtml_a4d3bb34842f24c4f16e09dad7fee71e8"><div class="ttname"><a href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml#a4d3bb34842f24c4f16e09dad7fee71e8">arm::pipe::TestProfilingConnectionBase::m_FirstCall</a></div><div class="ttdeci">bool m_FirstCall</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_tests_8hpp_source.xhtml#l00064">ProfilingTests.hpp:64</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a42eb542b5a1d73d00c4ce474140bb78c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a42eb542b5a1d73d00c4ce474140bb78c">◆ </a></span>WritePacket()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool WritePacket </td> + <td>(</td> + <td class="paramtype">const unsigned char * </td> + <td class="paramname"><em>buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>length</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 class="mlabel">override</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00041">41</a> of file <a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.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="l00042"></a><span class="lineno"> 42</span>  {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">arm::pipe::IgnoreUnused</a>(buffer, length);</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>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  }</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> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a4d3bb34842f24c4f16e09dad7fee71e8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4d3bb34842f24c4f16e09dad7fee71e8">◆ </a></span>m_FirstCall</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool m_FirstCall = true</td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00064">64</a> of file <a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00048">TestProfilingConnectionBase::ReadPacket()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>src/profiling/test/<a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.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="namespacearm.xhtml">arm</a></li><li class="navelem"><a class="el" href="namespacearm_1_1pipe.xhtml">pipe</a></li><li class="navelem"><a class="el" href="classarm_1_1pipe_1_1_test_profiling_connection_base.xhtml">TestProfilingConnectionBase</a></li> + <li class="footer">Generated on Fri Aug 19 2022 14:38:36 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> |