<!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"/>
<title>FIFE: FIFE::Logger Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FIFE <span id="projectnumber">2008.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li id="searchli">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('class_f_i_f_e_1_1_logger.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">FIFE::Logger Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="FIFE::Logger" -->
<p><code>#include <<a class="el" href="logger_8h_source.html">logger.h</a>></code></p>
<p><a href="class_f_i_f_e_1_1_logger-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_logger.html#a533f2fe267aa2b41a9c7d7df0cf3e386">Logger</a> (logmodule_t module)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_logger.html#a438ab22f893ff561f364b77d068d3c77">~Logger</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_logger.html#a9facd80a640c4a627b1ddce7a92d3cdd">log</a> (<a class="el" href="class_f_i_f_e_1_1_log_manager.html#af2e9fb1930881c1e840fa7263800b90d">LogManager::LogLevel</a> level, const std::string &msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_logger.html#a648c5284e2a7e98593bd3f9165ba3383">log</a> (<a class="el" href="class_f_i_f_e_1_1_log_manager.html#af2e9fb1930881c1e840fa7263800b90d">LogManager::LogLevel</a> level, const <a class="el" href="class_f_i_f_e_1_1_l_msg.html">LMsg</a> &msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">logmodule_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_logger.html#a5a4dfb93d862562bc5f436f8a9ea0dae">getModule</a> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Create a <a class="el" href="class_f_i_f_e_1_1_logger.html">Logger</a> instance to communicate with <a class="el" href="class_f_i_f_e_1_1_log_manager.html">LogManager</a> <a class="el" href="class_f_i_f_e_1_1_logger.html">Logger</a> stores information about the current module thus reducing the typing needed for individual traces Common way of doing things is to instantiate a static <a class="el" href="class_f_i_f_e_1_1_logger.html">Logger</a> on top of .cpp file and then use that in .cpp-file's methods </p>
<p>Definition at line <a class="el" href="logger_8h_source.html#l00209">209</a> of file <a class="el" href="logger_8h_source.html">logger.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a533f2fe267aa2b41a9c7d7df0cf3e386"></a><!-- doxytag: member="FIFE::Logger::Logger" ref="a533f2fe267aa2b41a9c7d7df0cf3e386" args="(logmodule_t module)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FIFE::Logger::Logger </td>
<td>(</td>
<td class="paramtype">logmodule_t </td>
<td class="paramname"><em>module</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates new logger and associates it with given module </p>
<p>Definition at line <a class="el" href="logger_8cpp_source.html#l00051">51</a> of file <a class="el" href="logger_8cpp_source.html">logger.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a438ab22f893ff561f364b77d068d3c77"></a><!-- doxytag: member="FIFE::Logger::~Logger" ref="a438ab22f893ff561f364b77d068d3c77" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FIFE::Logger::~Logger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
<p>Definition at line <a class="el" href="logger_8cpp_source.html#l00055">55</a> of file <a class="el" href="logger_8cpp_source.html">logger.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5a4dfb93d862562bc5f436f8a9ea0dae"></a><!-- doxytag: member="FIFE::Logger::getModule" ref="a5a4dfb93d862562bc5f436f8a9ea0dae" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">logmodule_t FIFE::Logger::getModule </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>gets module where this logger is associated to </p>
<p>Definition at line <a class="el" href="logger_8h_source.html#l00230">230</a> of file <a class="el" href="logger_8h_source.html">logger.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9facd80a640c4a627b1ddce7a92d3cdd"></a><!-- doxytag: member="FIFE::Logger::log" ref="a9facd80a640c4a627b1ddce7a92d3cdd" args="(LogManager::LogLevel level, const std::string &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::Logger::log </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_f_i_f_e_1_1_log_manager.html#af2e9fb1930881c1e840fa7263800b90d">LogManager::LogLevel</a> </td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>msg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>logs given message with given log level </p>
<p>Definition at line <a class="el" href="logger_8cpp_source.html#l00058">58</a> of file <a class="el" href="logger_8cpp_source.html">logger.cpp</a>.</p>
<p>References <a class="el" href="logger_8cpp_source.html#l00066">FIFE::LogManager::instance()</a>, and <a class="el" href="logger_8cpp_source.html#l00078">FIFE::LogManager::log()</a>.</p>
</div>
</div>
<a class="anchor" id="a648c5284e2a7e98593bd3f9165ba3383"></a><!-- doxytag: member="FIFE::Logger::log" ref="a648c5284e2a7e98593bd3f9165ba3383" args="(LogManager::LogLevel level, const LMsg &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::Logger::log </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_f_i_f_e_1_1_log_manager.html#af2e9fb1930881c1e840fa7263800b90d">LogManager::LogLevel</a> </td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_f_i_f_e_1_1_l_msg.html">LMsg</a> & </td>
<td class="paramname"><em>msg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>logs given message with given log level. Message is wrapped into <a class="el" href="class_f_i_f_e_1_1_l_msg.html">LMsg</a> instance for easy formatting </p>
<p>Definition at line <a class="el" href="logger_8cpp_source.html#l00062">62</a> of file <a class="el" href="logger_8cpp_source.html">logger.cpp</a>.</p>
<p>References <a class="el" href="logger_8cpp_source.html#l00066">FIFE::LogManager::instance()</a>, and <a class="el" href="logger_8cpp_source.html#l00078">FIFE::LogManager::log()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>engine/core/util/log/<a class="el" href="logger_8h_source.html">logger.h</a></li>
<li>engine/core/util/log/<a class="el" href="logger_8cpp_source.html">logger.cpp</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_f_i_f_e.html">FIFE</a> </li>
<li class="navelem"><a class="el" href="class_f_i_f_e_1_1_logger.html">Logger</a> </li>
<li class="footer">Generated on Sun Jul 10 2011 for FIFE by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a></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>
</body>
</html>
