Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 884746d2677e50c47b4bc70a2829a777344f73c4 / . / Documentation / classarmnn_1_1_simple_logger.xhtml
blob: 4df50683ff0d91f2759be6c2c01f4f4b7577ae37 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: SimpleLogger&lt; Level &gt; Class Template Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1_simple_logger.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
100<a href="classarmnn_1_1_simple_logger-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">SimpleLogger&lt; Level &gt; Class Template Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p><code>#include &lt;<a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>&gt;</code></p>
107<table class="memberdecls">
108<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
109Public Member Functions</h2></td></tr>
110<tr class="memitem:ae90a38afeeaa40547a8e199571208c37"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_simple_logger.xhtml#ae90a38afeeaa40547a8e199571208c37">SimpleLogger</a> ()</td></tr>
111<tr class="separator:ae90a38afeeaa40547a8e199571208c37"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<tr class="memitem:a19c7e3a87f2ba3600d28bca9aaeac448"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_simple_logger.xhtml#a19c7e3a87f2ba3600d28bca9aaeac448">Enable</a> (bool enable=<a class="el" href="_ref_layer_tests_8cpp.xhtml#a37f1c3ccc9fc906be85185350dd83d48">true</a>)</td></tr>
113<tr class="separator:a19c7e3a87f2ba3600d28bca9aaeac448"><td class="memSeparator" colspan="2">&#160;</td></tr>
114<tr class="memitem:a160c449b1afad351d2d63a8544a579f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_simple_logger.xhtml#a160c449b1afad351d2d63a8544a579f5">StartNewRecord</a> ()</td></tr>
115<tr class="separator:a160c449b1afad351d2d63a8544a579f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:a81e69cbbaa8569c47297d9fe05fb6a7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_simple_logger.xhtml#a81e69cbbaa8569c47297d9fe05fb6a7e">RemoveAllSinks</a> ()</td></tr>
117<tr class="separator:a81e69cbbaa8569c47297d9fe05fb6a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:af9d1246d79679d4ff21cf40f34233cbc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_simple_logger.xhtml#af9d1246d79679d4ff21cf40f34233cbc">AddSink</a> (std::shared_ptr&lt; <a class="el" href="classarmnn_1_1_log_sink.xhtml">LogSink</a> &gt; sink)</td></tr>
119<tr class="separator:af9d1246d79679d4ff21cf40f34233cbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
120</table><table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
122Static Public Member Functions</h2></td></tr>
123<tr class="memitem:a59e0938e18c610b3596598363c01a01c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarmnn_1_1_simple_logger.xhtml">SimpleLogger</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_simple_logger.xhtml#a59e0938e18c610b3596598363c01a01c">Get</a> ()</td></tr>
124<tr class="separator:a59e0938e18c610b3596598363c01a01c"><td class="memSeparator" colspan="2">&#160;</td></tr>
125</table>
126<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
127<div class="textblock"><h3>template&lt;LogSeverity Level&gt;<br />
128class armnn::SimpleLogger&lt; Level &gt;</h3>
129
130
131<p class="definition">Definition at line <a class="el" href="_logging_8hpp_source.xhtml#l00103">103</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p>
132</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
133<a id="ae90a38afeeaa40547a8e199571208c37"></a>
134<h2 class="memtitle"><span class="permalink"><a href="#ae90a38afeeaa40547a8e199571208c37">&#9670;&nbsp;</a></span>SimpleLogger()</h2>
135
136<div class="memitem">
137<div class="memproto">
138<table class="mlabels">
139 <tr>
140 <td class="mlabels-left">
141 <table class="memname">
142 <tr>
143 <td class="memname"><a class="el" href="classarmnn_1_1_simple_logger.xhtml">SimpleLogger</a> </td>
144 <td>(</td>
145 <td class="paramname"></td><td>)</td>
146 <td></td>
147 </tr>
148 </table>
149 </td>
150 <td class="mlabels-right">
151<span class="mlabels"><span class="mlabel">inline</span></span> </td>
152 </tr>
153</table>
154</div><div class="memdoc">
155
156<p class="definition">Definition at line <a class="el" href="_logging_8hpp_source.xhtml#l00106">106</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p>
157<div class="fragment"><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; : m_Sinks{std::make_shared&lt;StandardOutputSink&gt;()}</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; , m_Enable(<span class="keyword">true</span>)</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; }</div></div><!-- fragment -->
158</div>
159</div>
160<h2 class="groupheader">Member Function Documentation</h2>
161<a id="af9d1246d79679d4ff21cf40f34233cbc"></a>
162<h2 class="memtitle"><span class="permalink"><a href="#af9d1246d79679d4ff21cf40f34233cbc">&#9670;&nbsp;</a></span>AddSink()</h2>
163
164<div class="memitem">
165<div class="memproto">
166<table class="mlabels">
167 <tr>
168 <td class="mlabels-left">
169 <table class="memname">
170 <tr>
171 <td class="memname">void AddSink </td>
172 <td>(</td>
173 <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarmnn_1_1_log_sink.xhtml">LogSink</a> &gt;&#160;</td>
174 <td class="paramname"><em>sink</em></td><td>)</td>
175 <td></td>
176 </tr>
177 </table>
178 </td>
179 <td class="mlabels-right">
180<span class="mlabels"><span class="mlabel">inline</span></span> </td>
181 </tr>
182</table>
183</div><div class="memdoc">
184
185<p class="definition">Definition at line <a class="el" href="_logging_8hpp_source.xhtml#l00134">134</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p>
186
187<p class="reference">References <a class="el" href="_logging_8cpp_source.xhtml#l00146">armnn::SetAllLoggingSinks()</a>, and <a class="el" href="_logging_8cpp_source.xhtml#l00028">armnn::SetLogFilter()</a>.</p>
188
189<p class="reference">Referenced by <a class="el" href="_logging_8cpp_source.xhtml#l00122">armnn::SetLoggingSinks()</a>.</p>
190<div class="fragment"><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; m_Sinks.push_back(sink);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; }</div></div><!-- fragment -->
191</div>
192</div>
193<a id="a19c7e3a87f2ba3600d28bca9aaeac448"></a>
194<h2 class="memtitle"><span class="permalink"><a href="#a19c7e3a87f2ba3600d28bca9aaeac448">&#9670;&nbsp;</a></span>Enable()</h2>
195
196<div class="memitem">
197<div class="memproto">
198<table class="mlabels">
199 <tr>
200 <td class="mlabels-left">
201 <table class="memname">
202 <tr>
203 <td class="memname">void Enable </td>
204 <td>(</td>
205 <td class="paramtype">bool&#160;</td>
206 <td class="paramname"><em>enable</em> = <code><a class="el" href="_ref_layer_tests_8cpp.xhtml#a37f1c3ccc9fc906be85185350dd83d48">true</a></code></td><td>)</td>
207 <td></td>
208 </tr>
209 </table>
210 </td>
211 <td class="mlabels-right">
212<span class="mlabels"><span class="mlabel">inline</span></span> </td>
213 </tr>
214</table>
215</div><div class="memdoc">
216
217<p class="definition">Definition at line <a class="el" href="_logging_8hpp_source.xhtml#l00118">118</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p>
218
219<p class="reference">Referenced by <a class="el" href="_logging_8cpp_source.xhtml#l00028">armnn::SetLogFilter()</a>.</p>
220<div class="fragment"><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; {</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; m_Enable = enable;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; }</div></div><!-- fragment -->
221</div>
222</div>
223<a id="a59e0938e18c610b3596598363c01a01c"></a>
224<h2 class="memtitle"><span class="permalink"><a href="#a59e0938e18c610b3596598363c01a01c">&#9670;&nbsp;</a></span>Get()</h2>
225
226<div class="memitem">
227<div class="memproto">
228<table class="mlabels">
229 <tr>
230 <td class="mlabels-left">
231 <table class="memname">
232 <tr>
233 <td class="memname">static <a class="el" href="classarmnn_1_1_simple_logger.xhtml">SimpleLogger</a>&amp; Get </td>
234 <td>(</td>
235 <td class="paramname"></td><td>)</td>
236 <td></td>
237 </tr>
238 </table>
239 </td>
240 <td class="mlabels-right">
241<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
242 </tr>
243</table>
244</div><div class="memdoc">
245
246<p class="definition">Definition at line <a class="el" href="_logging_8hpp_source.xhtml#l00112">112</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p>
247
248<p class="reference">Referenced by <a class="el" href="_logging_8cpp_source.xhtml#l00028">armnn::SetLogFilter()</a>, and <a class="el" href="_logging_8cpp_source.xhtml#l00122">armnn::SetLoggingSinks()</a>.</p>
249<div class="fragment"><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keyword">static</span> SimpleLogger&lt;Level&gt; logger;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">return</span> logger;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; }</div></div><!-- fragment -->
250</div>
251</div>
252<a id="a81e69cbbaa8569c47297d9fe05fb6a7e"></a>
253<h2 class="memtitle"><span class="permalink"><a href="#a81e69cbbaa8569c47297d9fe05fb6a7e">&#9670;&nbsp;</a></span>RemoveAllSinks()</h2>
254
255<div class="memitem">
256<div class="memproto">
257<table class="mlabels">
258 <tr>
259 <td class="mlabels-left">
260 <table class="memname">
261 <tr>
262 <td class="memname">void RemoveAllSinks </td>
263 <td>(</td>
264 <td class="paramname"></td><td>)</td>
265 <td></td>
266 </tr>
267 </table>
268 </td>
269 <td class="mlabels-right">
270<span class="mlabels"><span class="mlabel">inline</span></span> </td>
271 </tr>
272</table>
273</div><div class="memdoc">
274
275<p class="definition">Definition at line <a class="el" href="_logging_8hpp_source.xhtml#l00129">129</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p>
276
277<p class="reference">Referenced by <a class="el" href="_logging_8cpp_source.xhtml#l00122">armnn::SetLoggingSinks()</a>.</p>
278<div class="fragment"><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; {</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; m_Sinks.clear();</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; }</div></div><!-- fragment -->
279</div>
280</div>
281<a id="a160c449b1afad351d2d63a8544a579f5"></a>
282<h2 class="memtitle"><span class="permalink"><a href="#a160c449b1afad351d2d63a8544a579f5">&#9670;&nbsp;</a></span>StartNewRecord()</h2>
283
284<div class="memitem">
285<div class="memproto">
286<table class="mlabels">
287 <tr>
288 <td class="mlabels-left">
289 <table class="memname">
290 <tr>
291 <td class="memname"><a class="el" href="structarmnn_1_1_scoped_record.xhtml">ScopedRecord</a> StartNewRecord </td>
292 <td>(</td>
293 <td class="paramname"></td><td>)</td>
294 <td></td>
295 </tr>
296 </table>
297 </td>
298 <td class="mlabels-right">
299<span class="mlabels"><span class="mlabel">inline</span></span> </td>
300 </tr>
301</table>
302</div><div class="memdoc">
303
304<p class="definition">Definition at line <a class="el" href="_logging_8hpp_source.xhtml#l00123">123</a> of file <a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a>.</p>
305<div class="fragment"><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; {</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; ScopedRecord record(m_Sinks, Level, m_Enable);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">return</span> record;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; }</div></div><!-- fragment -->
306</div>
307</div>
308<hr/>The documentation for this class was generated from the following file:<ul>
309<li>include/armnn/<a class="el" href="_logging_8hpp_source.xhtml">Logging.hpp</a></li>
310</ul>
311</div><!-- contents -->
312</div><!-- doc-content -->
313<!-- start footer part -->
314<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
315 <ul>
316 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_simple_logger.xhtml">SimpleLogger</a></li>
317 <li class="footer">Generated on Fri Mar 13 2020 16:09:20 for ArmNN by
318 <a href="http://www.doxygen.org/index.html">
319 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
320 </ul>
321</div>
322</body>
323</html>