classutil_1_1Logger.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415
  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.12"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Tracore: util::Logger Class 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="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <script type="text/javascript">
  16. $(document).ready(function() { init_search(); });
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">Tracore
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.12 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><b>util</b></li><li class="navelem"><a class="el" href="classutil_1_1Logger.html">Logger</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> &#124;
  90. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  91. <a href="classutil_1_1Logger-members.html">List of all members</a> </div>
  92. <div class="headertitle">
  93. <div class="title">util::Logger Class Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p><code>#include &lt;<a class="el" href="Logger_8h_source.html">Logger.h</a>&gt;</code></p>
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <tr class="memitem:a83d4f38e648b39fa61a2b9b3172bda12"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a83d4f38e648b39fa61a2b9b3172bda12">Logger</a> (<a class="el" href="classutil_1_1Logger.html">Logger</a> const &amp;)=delete</td></tr>
  101. <tr class="separator:a83d4f38e648b39fa61a2b9b3172bda12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a4e9e8b8d0e75058265037976d9b256de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a4e9e8b8d0e75058265037976d9b256de">operator=</a> (<a class="el" href="classutil_1_1Logger.html">Logger</a> const &amp;)=delete</td></tr>
  103. <tr class="separator:a4e9e8b8d0e75058265037976d9b256de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table><table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  106. Static Public Member Functions</h2></td></tr>
  107. <tr class="memitem:a734bbf94e1232706f7c0bf52745cc876"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classutil_1_1Logger.html">Logger</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a734bbf94e1232706f7c0bf52745cc876">Instance</a> ()</td></tr>
  108. <tr class="separator:a734bbf94e1232706f7c0bf52745cc876"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ac7b9bc580a6d459c212c46b137742869"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#ac7b9bc580a6d459c212c46b137742869">SetDebug</a> (bool debug)</td></tr>
  110. <tr class="separator:ac7b9bc580a6d459c212c46b137742869"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a3965358e412007989f90798e295d4b41"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a3965358e412007989f90798e295d4b41">SetInfo</a> (bool info)</td></tr>
  112. <tr class="separator:a3965358e412007989f90798e295d4b41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a6ee9298451936b98815e20ba7f5d7275"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a6ee9298451936b98815e20ba7f5d7275">IsDebugEnabled</a> ()</td></tr>
  114. <tr class="separator:a6ee9298451936b98815e20ba7f5d7275"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a194b338af92760d0f7d15b607cad5429"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a194b338af92760d0f7d15b607cad5429">IsInfoEnabled</a> ()</td></tr>
  116. <tr class="separator:a194b338af92760d0f7d15b607cad5429"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a65ac30aaefded61036771197f1364bb8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a65ac30aaefded61036771197f1364bb8">LogInfo</a> (std::string const &amp;message)</td></tr>
  118. <tr class="separator:a65ac30aaefded61036771197f1364bb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a5a49cf31bcd5a0ccbfe11667b37f338a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a5a49cf31bcd5a0ccbfe11667b37f338a">LogError</a> (std::string const &amp;message)</td></tr>
  120. <tr class="separator:a5a49cf31bcd5a0ccbfe11667b37f338a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a89b67d19ea6650ed313dffc0a599385a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a89b67d19ea6650ed313dffc0a599385a">LogDebug</a> (std::string const &amp;message)</td></tr>
  122. <tr class="separator:a89b67d19ea6650ed313dffc0a599385a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table>
  124. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  125. <div class="textblock"><p>Utility class for logging. Is a singleton. Provides three different types of messages. </p>
  126. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  127. <a class="anchor" id="a83d4f38e648b39fa61a2b9b3172bda12"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="mlabels">
  131. <tr>
  132. <td class="mlabels-left">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">util::Logger::Logger </td>
  136. <td>(</td>
  137. <td class="paramtype"><a class="el" href="classutil_1_1Logger.html">Logger</a> const &amp;&#160;</td>
  138. <td class="paramname"></td><td>)</td>
  139. <td></td>
  140. </tr>
  141. </table>
  142. </td>
  143. <td class="mlabels-right">
  144. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>-&gt; Singleton </p>
  149. </div>
  150. </div>
  151. <h2 class="groupheader">Member Function Documentation</h2>
  152. <a class="anchor" id="a734bbf94e1232706f7c0bf52745cc876"></a>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">static <a class="el" href="classutil_1_1Logger.html">Logger</a>&amp; util::Logger::Instance </td>
  161. <td>(</td>
  162. <td class="paramname"></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </td>
  167. <td class="mlabels-right">
  168. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <p>Gets THE instance of this singleton. Creates a new instance if not already created. </p>
  173. </div>
  174. </div>
  175. <a class="anchor" id="a6ee9298451936b98815e20ba7f5d7275"></a>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="mlabels">
  179. <tr>
  180. <td class="mlabels-left">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">bool util::Logger::IsDebugEnabled </td>
  184. <td>(</td>
  185. <td class="paramname"></td><td>)</td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </td>
  190. <td class="mlabels-right">
  191. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>If the debug messages are logged. </p><dl class="section return"><dt>Returns</dt><dd>True, if the debug messages are logged </dd></dl>
  196. </div>
  197. </div>
  198. <a class="anchor" id="a194b338af92760d0f7d15b607cad5429"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="mlabels">
  202. <tr>
  203. <td class="mlabels-left">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">bool util::Logger::IsInfoEnabled </td>
  207. <td>(</td>
  208. <td class="paramname"></td><td>)</td>
  209. <td></td>
  210. </tr>
  211. </table>
  212. </td>
  213. <td class="mlabels-right">
  214. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>If the info messages are logged. </p><dl class="section return"><dt>Returns</dt><dd>True, if the info messages are logged </dd></dl>
  219. </div>
  220. </div>
  221. <a class="anchor" id="a89b67d19ea6650ed313dffc0a599385a"></a>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">void util::Logger::LogDebug </td>
  230. <td>(</td>
  231. <td class="paramtype">std::string const &amp;&#160;</td>
  232. <td class="paramname"><em>message</em></td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </td>
  237. <td class="mlabels-right">
  238. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Logs the given message as an debug message. </p><dl class="params"><dt>Parameters</dt><dd>
  243. <table class="params">
  244. <tr><td class="paramname">message</td><td>The debug message to log </td></tr>
  245. </table>
  246. </dd>
  247. </dl>
  248. </div>
  249. </div>
  250. <a class="anchor" id="a5a49cf31bcd5a0ccbfe11667b37f338a"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="mlabels">
  254. <tr>
  255. <td class="mlabels-left">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">void util::Logger::LogError </td>
  259. <td>(</td>
  260. <td class="paramtype">std::string const &amp;&#160;</td>
  261. <td class="paramname"><em>message</em></td><td>)</td>
  262. <td></td>
  263. </tr>
  264. </table>
  265. </td>
  266. <td class="mlabels-right">
  267. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Logs the given message as an error message. </p><dl class="params"><dt>Parameters</dt><dd>
  272. <table class="params">
  273. <tr><td class="paramname">message</td><td>The error message to log </td></tr>
  274. </table>
  275. </dd>
  276. </dl>
  277. </div>
  278. </div>
  279. <a class="anchor" id="a65ac30aaefded61036771197f1364bb8"></a>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="mlabels">
  283. <tr>
  284. <td class="mlabels-left">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">void util::Logger::LogInfo </td>
  288. <td>(</td>
  289. <td class="paramtype">std::string const &amp;&#160;</td>
  290. <td class="paramname"><em>message</em></td><td>)</td>
  291. <td></td>
  292. </tr>
  293. </table>
  294. </td>
  295. <td class="mlabels-right">
  296. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Logs the given message as an info message. </p><dl class="params"><dt>Parameters</dt><dd>
  301. <table class="params">
  302. <tr><td class="paramname">message</td><td>The info message to log </td></tr>
  303. </table>
  304. </dd>
  305. </dl>
  306. </div>
  307. </div>
  308. <a class="anchor" id="a4e9e8b8d0e75058265037976d9b256de"></a>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="mlabels">
  312. <tr>
  313. <td class="mlabels-left">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">void util::Logger::operator= </td>
  317. <td>(</td>
  318. <td class="paramtype"><a class="el" href="classutil_1_1Logger.html">Logger</a> const &amp;&#160;</td>
  319. <td class="paramname"></td><td>)</td>
  320. <td></td>
  321. </tr>
  322. </table>
  323. </td>
  324. <td class="mlabels-right">
  325. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. <p>-&gt; Singleton </p>
  330. </div>
  331. </div>
  332. <a class="anchor" id="ac7b9bc580a6d459c212c46b137742869"></a>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="mlabels">
  336. <tr>
  337. <td class="mlabels-left">
  338. <table class="memname">
  339. <tr>
  340. <td class="memname">void util::Logger::SetDebug </td>
  341. <td>(</td>
  342. <td class="paramtype">bool&#160;</td>
  343. <td class="paramname"><em>debug</em></td><td>)</td>
  344. <td></td>
  345. </tr>
  346. </table>
  347. </td>
  348. <td class="mlabels-right">
  349. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Sets the debug message logging. </p><dl class="params"><dt>Parameters</dt><dd>
  354. <table class="params">
  355. <tr><td class="paramname">debug</td><td>True, if the debug messages should be logged </td></tr>
  356. </table>
  357. </dd>
  358. </dl>
  359. </div>
  360. </div>
  361. <a class="anchor" id="a3965358e412007989f90798e295d4b41"></a>
  362. <div class="memitem">
  363. <div class="memproto">
  364. <table class="mlabels">
  365. <tr>
  366. <td class="mlabels-left">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">void util::Logger::SetInfo </td>
  370. <td>(</td>
  371. <td class="paramtype">bool&#160;</td>
  372. <td class="paramname"><em>info</em></td><td>)</td>
  373. <td></td>
  374. </tr>
  375. </table>
  376. </td>
  377. <td class="mlabels-right">
  378. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  379. </tr>
  380. </table>
  381. </div><div class="memdoc">
  382. <p>Sets the info message logging. </p><dl class="params"><dt>Parameters</dt><dd>
  383. <table class="params">
  384. <tr><td class="paramname">info</td><td>True, if the info messages should be logged </td></tr>
  385. </table>
  386. </dd>
  387. </dl>
  388. </div>
  389. </div>
  390. <hr/>The documentation for this class was generated from the following files:<ul>
  391. <li>util/<a class="el" href="Logger_8h_source.html">Logger.h</a></li>
  392. <li>util/Logger.cpp</li>
  393. </ul>
  394. </div><!-- contents -->
  395. <!-- start footer part -->
  396. <hr class="footer"/><address class="footer"><small>
  397. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  398. <img class="footer" src="doxygen.png" alt="doxygen"/>
  399. </a> 1.8.12
  400. </small></address>
  401. </body>
  402. </html>