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