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_1gatordmock_1_1_command_file_parser.html b/Documentation/classarmnn_1_1gatordmock_1_1_command_file_parser.html
new file mode 100644
index 0000000..0a94ba7
--- /dev/null
+++ b/Documentation/classarmnn_1_1gatordmock_1_1_command_file_parser.html
@@ -0,0 +1,154 @@
+<!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="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: CommandFileParser 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>
+<link href="doxygen.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;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">ArmNN
+  <span id="projectnumber">NotReleased</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_1gatordmock_1_1_command_file_parser.html','');});
+</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_1gatordmock_1_1_command_file_parser-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">CommandFileParser Class Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="_command_file_parser_8hpp_source.html">CommandFileParser.hpp</a>></code></p>
+<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:a224fc15053b9579998ce82f22038bab1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1gatordmock_1_1_command_file_parser.html#a224fc15053b9579998ce82f22038bab1">ParseFile</a> (std::string CommandFile, <a class="el" href="classarmnn_1_1gatordmock_1_1_gatord_mock_service.html">GatordMockService</a> &mockService)</td></tr>
+<tr class="separator:a224fc15053b9579998ce82f22038bab1"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>This class parses a command file for the <a class="el" href="classarmnn_1_1gatordmock_1_1_gatord_mock_service.html">GatordMockService</a>. The file contains one command per line. Valid commands are: SET and WAIT.</p>
+<p>SET: Will construct and send a PeriodicCounterSelection packet to enable a set of counters. WAIT: Will pause for a set period of time to allow for data to be received. </p>
+
+<p class="definition">Definition at line <a class="el" href="_command_file_parser_8hpp_source.html#l00022">22</a> of file <a class="el" href="_command_file_parser_8hpp_source.html">CommandFileParser.hpp</a>.</p>
+</div><h2 class="groupheader">Member Function Documentation</h2>
+<a id="a224fc15053b9579998ce82f22038bab1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a224fc15053b9579998ce82f22038bab1">◆ </a></span>ParseFile()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void ParseFile </td>
+ <td>(</td>
+ <td class="paramtype">std::string </td>
+ <td class="paramname"><em>CommandFile</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="classarmnn_1_1gatordmock_1_1_gatord_mock_service.html">GatordMockService</a> & </td>
+ <td class="paramname"><em>mockService</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_command_file_parser_8cpp_source.html#l00019">19</a> of file <a class="el" href="_command_file_parser_8cpp_source.html">CommandFileParser.cpp</a>.</p>
+
+<p class="reference">References <a class="el" href="_gatord_mock_service_8hpp_source.html#l00092">GatordMockService::ReceiveThreadRunning()</a>, <a class="el" href="_gatord_mock_service_8cpp_source.html#l00181">GatordMockService::SendPeriodicCounterSelectionList()</a>, <a class="el" href="_gatord_mock_service_8cpp_source.html#l00139">GatordMockService::SendRequestCounterDir()</a>, and <a class="el" href="_gatord_mock_service_8cpp_source.html#l00214">GatordMockService::WaitCommand()</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="_gatord_mock_main_8cpp_source.html#l00018">main()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  std::ifstream infile(CommandFile);</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  std::string line;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  std::cout << <span class="stringliteral">"Parsing command file: "</span> << CommandFile << std::endl;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">while</span> (mockService.ReceiveThreadRunning() && std::getline(infile, line))</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  std::istringstream iss(line);</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  std::vector<std::string> tokens;</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>  std::copy(std::istream_iterator<std::string>(iss), std::istream_iterator<std::string>(),</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  std::back_inserter(tokens));</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  std::string command = tokens[0];</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>  <span class="keywordflow">if</span> (command == <span class="stringliteral">"LIST"</span>)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// Expected format for the SET command</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">//</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// LIST</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">//</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  mockService.SendRequestCounterDir();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span> (command == <span class="stringliteral">"SET"</span>)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Expected format for the SET command</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">//</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// SET 500000 1 2 5 10</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">//</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// This breaks down to:</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// SET command</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// 500000 polling period in micro seconds</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// 1 2 5 10 counter list</span></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>  uint32_t period = <span class="keyword">static_cast<</span>uint32_t<span class="keyword">></span>(std::stoul(tokens[1]));</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::vector<uint16_t> counters;</div><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>  std::transform(tokens.begin() + 2, tokens.end(), std::back_inserter(counters),</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  [](<span class="keyword">const</span> std::string& str) { <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>uint16_t<span class="keyword">></span>(std::stoul(str)); });</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  mockService.SendPeriodicCounterSelectionList(period, counters);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (command == <span class="stringliteral">"WAIT"</span>)</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Expected format for the SET command</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">//</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// WAIT 11000000</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">//</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// This breaks down to:</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// WAIT command</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// 11000000 timeout period in micro seconds</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  uint32_t timeout = <span class="keyword">static_cast<</span>uint32_t<span class="keyword">></span>(std::stoul(tokens[1]));</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  mockService.WaitCommand(timeout);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> }</div></div><!-- fragment -->
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>tests/profiling/gatordmock/<a class="el" href="_command_file_parser_8hpp_source.html">CommandFileParser.hpp</a></li>
+<li>tests/profiling/gatordmock/<a class="el" href="_command_file_parser_8cpp_source.html">CommandFileParser.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.html">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1gatordmock.html">gatordmock</a></li><li class="navelem"><a class="el" href="classarmnn_1_1gatordmock_1_1_command_file_parser.html">CommandFileParser</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:07:05 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>