classutil_1_1Logger.html 17 KB

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