IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
diff --git a/Documentation/classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.xhtml b/Documentation/classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.xhtml
new file mode 100644
index 0000000..864a239
--- /dev/null
+++ b/Documentation/classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.xhtml
@@ -0,0 +1,253 @@
+<!-- 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: TestProfilingConnectionTimeoutError 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.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_test_profiling_connection_timeout_error.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_test_profiling_connection_timeout_error-members.xhtml">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">TestProfilingConnectionTimeoutError 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 TestProfilingConnectionTimeoutError:</div>
+<div class="dyncontent">
+ <div class="center">
+ <img src="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.png" usemap="#TestProfilingConnectionTimeoutError_map" alt=""/>
+ <map id="TestProfilingConnectionTimeoutError_map" name="TestProfilingConnectionTimeoutError_map">
+<area href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml" alt="TestProfilingConnectionBase" shape="rect" coords="0,56,219,80"/>
+<area href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml" alt="IProfilingConnection" shape="rect" coords="0,0,219,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:a18f0288913ca61defcaa34c8d0a40e8c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.xhtml#a18f0288913ca61defcaa34c8d0a40e8c">TestProfilingConnectionTimeoutError</a> ()</td></tr>
+<tr class="separator:a18f0288913ca61defcaa34c8d0a40e8c"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a1adbda8257d3a74a0566e0d8407ff458"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1profiling_1_1_packet.xhtml">Packet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.xhtml#a1adbda8257d3a74a0566e0d8407ff458">ReadPacket</a> (uint32_t timeout) override</td></tr>
+<tr class="separator:a1adbda8257d3a74a0566e0d8407ff458"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:afb1d388dbb6bed7623ef1d3fb52fb52b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_timeout_error.xhtml#afb1d388dbb6bed7623ef1d3fb52fb52b">ReadCalledCount</a> ()</td></tr>
+<tr class="separator:afb1d388dbb6bed7623ef1d3fb52fb52b"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="inherit_header pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml">TestProfilingConnectionBase</a></td></tr>
+<tr class="memitem:abfb705bcb10894813d612267dcb1be70 inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#abfb705bcb10894813d612267dcb1be70">TestProfilingConnectionBase</a> ()=default</td></tr>
+<tr class="separator:abfb705bcb10894813d612267dcb1be70 inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:aab93b740524e1d31882e71eab460cbc2 inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#aab93b740524e1d31882e71eab460cbc2">~TestProfilingConnectionBase</a> ()=default</td></tr>
+<tr class="separator:aab93b740524e1d31882e71eab460cbc2 inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a91bdc9d5497d47f5d707418beb83b140 inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a91bdc9d5497d47f5d707418beb83b140">IsOpen</a> () const override</td></tr>
+<tr class="separator:a91bdc9d5497d47f5d707418beb83b140 inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a0f9aecd570c4e5e6d41337f0e2f1adf5 inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a0f9aecd570c4e5e6d41337f0e2f1adf5">Close</a> () override</td></tr>
+<tr class="separator:a0f9aecd570c4e5e6d41337f0e2f1adf5 inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a42eb542b5a1d73d00c4ce474140bb78c inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a42eb542b5a1d73d00c4ce474140bb78c">WritePacket</a> (const unsigned char *buffer, uint32_t length) override</td></tr>
+<tr class="separator:a42eb542b5a1d73d00c4ce474140bb78c inherit pub_methods_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="inherit_header pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a></td></tr>
+<tr class="memitem:a8c5a75b8ee005a7aa9391f3991480d74 inherit pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml#a8c5a75b8ee005a7aa9391f3991480d74">~IProfilingConnection</a> ()</td></tr>
+<tr class="separator:a8c5a75b8ee005a7aa9391f3991480d74 inherit pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection"><td class="memSeparator" colspan="2"> </td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
+Additional Inherited Members</h2></td></tr>
+<tr class="inherit_header pub_attribs_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classarmnn_1_1profiling_1_1_test_profiling_connection_base')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml">TestProfilingConnectionBase</a></td></tr>
+<tr class="memitem:a4d3bb34842f24c4f16e09dad7fee71e8 inherit pub_attribs_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a4d3bb34842f24c4f16e09dad7fee71e8">m_FirstCall</a> = <a class="el" href="_ref_layer_tests_8cpp.xhtml#a37f1c3ccc9fc906be85185350dd83d48">true</a></td></tr>
+<tr class="separator:a4d3bb34842f24c4f16e09dad7fee71e8 inherit pub_attribs_classarmnn_1_1profiling_1_1_test_profiling_connection_base"><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#l00104">104</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="a18f0288913ca61defcaa34c8d0a40e8c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a18f0288913ca61defcaa34c8d0a40e8c">◆ </a></span>TestProfilingConnectionTimeoutError()</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_test_profiling_connection_timeout_error.xhtml">TestProfilingConnectionTimeoutError</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> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00107">107</a> of file <a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  : m_ReadRequests(0)</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  {}</div></div><!-- fragment -->
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="afb1d388dbb6bed7623ef1d3fb52fb52b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afb1d388dbb6bed7623ef1d3fb52fb52b">◆ </a></span>ReadCalledCount()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">int ReadCalledCount </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="_profiling_tests_8hpp_source.xhtml#l00124">124</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_8cpp_source.xhtml#l00131">BOOST_AUTO_TEST_CASE()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  {</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">return</span> m_ReadRequests.load();</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  }</div></div><!-- fragment -->
+</div>
+</div>
+<a id="a1adbda8257d3a74a0566e0d8407ff458"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1adbda8257d3a74a0566e0d8407ff458">◆ </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"><a class="el" href="classarmnn_1_1profiling_1_1_packet.xhtml">Packet</a> 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 class="mlabel">virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Reimplemented from <a class="el" href="classarmnn_1_1profiling_1_1_test_profiling_connection_base.xhtml#a1adbda8257d3a74a0566e0d8407ff458">TestProfilingConnectionBase</a>.</p>
+
+<p class="definition">Definition at line <a class="el" href="_profiling_tests_8hpp_source.xhtml#l00111">111</a> of file <a class="el" href="_profiling_tests_8hpp_source.xhtml">ProfilingTests.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">// Return connection acknowledged packet after three timeouts</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">if</span> (m_ReadRequests % 3 == 0)</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  std::this_thread::sleep_for(std::chrono::milliseconds(timeout));</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  ++m_ReadRequests;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_timeout_exception.xhtml">armnn::TimeoutException</a>(<span class="stringliteral">"Simulate a timeout error\n"</span>);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">return</span> Packet(65536);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  }</div><div class="ttc" id="classarmnn_1_1_timeout_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_timeout_exception.xhtml">armnn::TimeoutException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00135">Exceptions.hpp:135</a></div></div>
+</div><!-- fragment -->
+</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="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_test_profiling_connection_timeout_error.xhtml">TestProfilingConnectionTimeoutError</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:09:21 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>