123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415 |
- <!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.12"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Tracore: util::Logger Class 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="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/javascript">
- $(document).ready(function() { init_search(); });
- </script>
- <link href="doxygen.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;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">Tracore
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.12 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- <!-- 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 id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><b>util</b></li><li class="navelem"><a class="el" href="classutil_1_1Logger.html">Logger</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="classutil_1_1Logger-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">util::Logger Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <<a class="el" href="Logger_8h_source.html">Logger.h</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:a83d4f38e648b39fa61a2b9b3172bda12"><td class="memItemLeft" align="right" valign="top"> </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 &)=delete</td></tr>
- <tr class="separator:a83d4f38e648b39fa61a2b9b3172bda12"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4e9e8b8d0e75058265037976d9b256de"><td class="memItemLeft" align="right" valign="top">void </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 &)=delete</td></tr>
- <tr class="separator:a4e9e8b8d0e75058265037976d9b256de"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a734bbf94e1232706f7c0bf52745cc876"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classutil_1_1Logger.html">Logger</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a734bbf94e1232706f7c0bf52745cc876">Instance</a> ()</td></tr>
- <tr class="separator:a734bbf94e1232706f7c0bf52745cc876"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac7b9bc580a6d459c212c46b137742869"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#ac7b9bc580a6d459c212c46b137742869">SetDebug</a> (bool debug)</td></tr>
- <tr class="separator:ac7b9bc580a6d459c212c46b137742869"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3965358e412007989f90798e295d4b41"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a3965358e412007989f90798e295d4b41">SetInfo</a> (bool info)</td></tr>
- <tr class="separator:a3965358e412007989f90798e295d4b41"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6ee9298451936b98815e20ba7f5d7275"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a6ee9298451936b98815e20ba7f5d7275">IsDebugEnabled</a> ()</td></tr>
- <tr class="separator:a6ee9298451936b98815e20ba7f5d7275"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a194b338af92760d0f7d15b607cad5429"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a194b338af92760d0f7d15b607cad5429">IsInfoEnabled</a> ()</td></tr>
- <tr class="separator:a194b338af92760d0f7d15b607cad5429"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a65ac30aaefded61036771197f1364bb8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a65ac30aaefded61036771197f1364bb8">LogInfo</a> (std::string const &message)</td></tr>
- <tr class="separator:a65ac30aaefded61036771197f1364bb8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5a49cf31bcd5a0ccbfe11667b37f338a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a5a49cf31bcd5a0ccbfe11667b37f338a">LogError</a> (std::string const &message)</td></tr>
- <tr class="separator:a5a49cf31bcd5a0ccbfe11667b37f338a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a89b67d19ea6650ed313dffc0a599385a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Logger.html#a89b67d19ea6650ed313dffc0a599385a">LogDebug</a> (std::string const &message)</td></tr>
- <tr class="separator:a89b67d19ea6650ed313dffc0a599385a"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Utility class for logging. Is a singleton. Provides three different types of messages. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a class="anchor" id="a83d4f38e648b39fa61a2b9b3172bda12"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">util::Logger::Logger </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classutil_1_1Logger.html">Logger</a> const & </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">
- <p>-> Singleton </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a734bbf94e1232706f7c0bf52745cc876"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="classutil_1_1Logger.html">Logger</a>& util::Logger::Instance </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 class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets THE instance of this singleton. Creates a new instance if not already created. </p>
- </div>
- </div>
- <a class="anchor" id="a6ee9298451936b98815e20ba7f5d7275"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool util::Logger::IsDebugEnabled </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a194b338af92760d0f7d15b607cad5429"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool util::Logger::IsInfoEnabled </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a89b67d19ea6650ed313dffc0a599385a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void util::Logger::LogDebug </td>
- <td>(</td>
- <td class="paramtype">std::string const & </td>
- <td class="paramname"><em>message</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Logs the given message as an debug message. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">message</td><td>The debug message to log </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a5a49cf31bcd5a0ccbfe11667b37f338a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void util::Logger::LogError </td>
- <td>(</td>
- <td class="paramtype">std::string const & </td>
- <td class="paramname"><em>message</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Logs the given message as an error message. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">message</td><td>The error message to log </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a65ac30aaefded61036771197f1364bb8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void util::Logger::LogInfo </td>
- <td>(</td>
- <td class="paramtype">std::string const & </td>
- <td class="paramname"><em>message</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Logs the given message as an info message. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">message</td><td>The info message to log </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a4e9e8b8d0e75058265037976d9b256de"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void util::Logger::operator= </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classutil_1_1Logger.html">Logger</a> const & </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">
- <p>-> Singleton </p>
- </div>
- </div>
- <a class="anchor" id="ac7b9bc580a6d459c212c46b137742869"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void util::Logger::SetDebug </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>debug</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the debug message logging. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">debug</td><td>True, if the debug messages should be logged </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a3965358e412007989f90798e295d4b41"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void util::Logger::SetInfo </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>info</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the info message logging. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">info</td><td>True, if the info messages should be logged </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>util/<a class="el" href="Logger_8h_source.html">Logger.h</a></li>
- <li>util/Logger.cpp</li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.12
- </small></address>
- </body>
- </html>
|