diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/structarmnn_1_1_scoped_record.xhtml | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/structarmnn_1_1_scoped_record.xhtml')
-rw-r--r-- | Documentation/structarmnn_1_1_scoped_record.xhtml | 351 |
1 files changed, 351 insertions, 0 deletions
diff --git a/Documentation/structarmnn_1_1_scoped_record.xhtml b/Documentation/structarmnn_1_1_scoped_record.xhtml new file mode 100644 index 0000000000..ec07b800ff --- /dev/null +++ b/Documentation/structarmnn_1_1_scoped_record.xhtml @@ -0,0 +1,351 @@ +<!-- 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: ScopedRecord Struct 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('structarmnn_1_1_scoped_record.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="structarmnn_1_1_scoped_record-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">ScopedRecord Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_logging_8hpp_source.xhtml">Logging.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:ae4a6710a55a38dab6779ed75c05d1fe2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_scoped_record.xhtml#ae4a6710a55a38dab6779ed75c05d1fe2">ScopedRecord</a> (const std::vector< std::shared_ptr< <a class="el" href="classarmnn_1_1_log_sink.xhtml">LogSink</a> >> &sinks, <a class="el" href="namespacearmnn.xhtml#a93a3ba385cad27c4774e5fe64c025d3d">LogSeverity</a> level, bool enabled)</td></tr> +<tr class="separator:ae4a6710a55a38dab6779ed75c05d1fe2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a82a59481d5560f520e79df5e11b14e6c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_scoped_record.xhtml#a82a59481d5560f520e79df5e11b14e6c">~ScopedRecord</a> ()</td></tr> +<tr class="separator:a82a59481d5560f520e79df5e11b14e6c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4d105499ebbdd15efe0d84f12c61bbb1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_scoped_record.xhtml#a4d105499ebbdd15efe0d84f12c61bbb1">ScopedRecord</a> (const <a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> &)=delete</td></tr> +<tr class="separator:a4d105499ebbdd15efe0d84f12c61bbb1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a79fe1271a7643847db0b191ef9013dd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_scoped_record.xhtml#a79fe1271a7643847db0b191ef9013dd8">operator=</a> (const <a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> &)=delete</td></tr> +<tr class="separator:a79fe1271a7643847db0b191ef9013dd8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aabad41d78fec30c1e5c7ab0720a1c542"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_scoped_record.xhtml#aabad41d78fec30c1e5c7ab0720a1c542">operator=</a> (<a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> &&)=delete</td></tr> +<tr class="separator:aabad41d78fec30c1e5c7ab0720a1c542"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a830f52e8575618a31c6629213a7ee0d2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_scoped_record.xhtml#a830f52e8575618a31c6629213a7ee0d2">ScopedRecord</a> (<a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> &&other)=default</td></tr> +<tr class="separator:a830f52e8575618a31c6629213a7ee0d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a548db6810f4334cddf0b0449bcb9e88e"><td class="memTemplParams" colspan="2">template<typename Streamable > </td></tr> +<tr class="memitem:a548db6810f4334cddf0b0449bcb9e88e"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_scoped_record.xhtml#a548db6810f4334cddf0b0449bcb9e88e">operator<<</a> (const Streamable &s)</td></tr> +<tr class="separator:a548db6810f4334cddf0b0449bcb9e88e"><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="_logging_8hpp_source.xhtml#l00054">54</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ae4a6710a55a38dab6779ed75c05d1fe2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae4a6710a55a38dab6779ed75c05d1fe2">◆ </a></span>ScopedRecord() <span class="overload">[1/3]</span></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="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> </td> + <td>(</td> + <td class="paramtype">const std::vector< std::shared_ptr< <a class="el" href="classarmnn_1_1_log_sink.xhtml">LogSink</a> >> & </td> + <td class="paramname"><em>sinks</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespacearmnn.xhtml#a93a3ba385cad27c4774e5fe64c025d3d">LogSeverity</a> </td> + <td class="paramname"><em>level</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>enabled</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="_logging_8hpp_source.xhtml#l00056">56</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_logging_8hpp_source.xhtml#l00014">armnn::LevelToString()</a>.</p> +<div class="fragment"><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  : m_LogSinks(sinks)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  , m_Enabled(enabled)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">if</span> (enabled)</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>  m_Os << <a class="code" href="namespacearmnn.xhtml#a71f2cc06b097cb5c4f0a1f48130a823b">LevelToString</a>(level) << <span class="stringliteral">": "</span>;</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>  }</div><div class="ttc" id="namespacearmnn_xhtml_a71f2cc06b097cb5c4f0a1f48130a823b"><div class="ttname"><a href="namespacearmnn.xhtml#a71f2cc06b097cb5c4f0a1f48130a823b">armnn::LevelToString</a></div><div class="ttdeci">std::string LevelToString(LogSeverity level)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8hpp_source.xhtml#l00014">Logging.hpp:14</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a82a59481d5560f520e79df5e11b14e6c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a82a59481d5560f520e79df5e11b14e6c">◆ </a></span>~ScopedRecord()</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="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</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="_logging_8hpp_source.xhtml#l00066">66</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p> +<div class="fragment"><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="keywordflow">if</span> (m_Enabled)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> sink : m_LogSinks)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span> (sink)</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  sink->Consume(m_Os.str());</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>  }</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>  }</div></div><!-- fragment --> +</div> +</div> +<a id="a4d105499ebbdd15efe0d84f12c61bbb1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4d105499ebbdd15efe0d84f12c61bbb1">◆ </a></span>ScopedRecord() <span class="overload">[2/3]</span></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="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> & </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a830f52e8575618a31c6629213a7ee0d2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a830f52e8575618a31c6629213a7ee0d2">◆ </a></span>ScopedRecord() <span class="overload">[3/3]</span></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="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> && </td> + <td class="paramname"><em>other</em></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="a548db6810f4334cddf0b0449bcb9e88e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a548db6810f4334cddf0b0449bcb9e88e">◆ </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"><a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a>& operator<< </td> + <td>(</td> + <td class="paramtype">const Streamable & </td> + <td class="paramname"><em>s</em></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="_logging_8hpp_source.xhtml#l00087">87</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">if</span> (m_Enabled)</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  m_Os << s;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">return</span> (*<span class="keyword">this</span>);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div></div><!-- fragment --> +</div> +</div> +<a id="a79fe1271a7643847db0b191ef9013dd8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a79fe1271a7643847db0b191ef9013dd8">◆ </a></span>operator=() <span class="overload">[1/2]</span></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="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a>& operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> & </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="aabad41d78fec30c1e5c7ab0720a1c542"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aabad41d78fec30c1e5c7ab0720a1c542">◆ </a></span>operator=() <span class="overload">[2/2]</span></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="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a>& operator= </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> && </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>include/armnn/<a class="el" href="_logging_8hpp_source.xhtml">Logging.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="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:20 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> |