<html>
<head>
<title>Ogre::Log class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::Log Class Reference</h1><a class="el" href="classOgre_1_1Log.html">Log</a> class for writing debug/log data to files.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreLog_8h-source.html">OgreLog.h</a>></code>
<p>
<a href="classOgre_1_1Log-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Loga0">Log</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name, bool debugOutput=true)</td></tr>
<tr><td> </td><td><font size=-1><em>Usual constructor - called by <a class="el" href="classOgre_1_1LogManager.html">LogManager</a>.</em> <a href="#Ogre_1_1Loga0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Loga1">~Log</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Default destructor.</em> <a href="#Ogre_1_1Loga1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Loga2">logMessage</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &message, <a class="el" href="namespaceOgre.html#a635">LogMessageLevel</a> lml=LML_NORMAL)</td></tr>
<tr><td> </td><td><font size=-1><em><a class="el" href="classOgre_1_1Log.html">Log</a> a message to the debugger and to log file (the default is "<code>OGRE.log</code>"),.</em> <a href="#Ogre_1_1Loga2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Loga3">setLogDetail</a> (<a class="el" href="namespaceOgre.html#a634">LoggingLevel</a> ll)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the level of the log detail.</em> <a href="#Ogre_1_1Loga3"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>std::ofstream </td><td valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logn0">mfpLog</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a634">LoggingLevel</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logn1">mLogLevel</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logn2">mDebugOut</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classOgre_1_1Log.html">Log</a> class for writing debug/log data to files.
<p>
<dl compact><dt><b>
Note: </b><dd>
<br>
Should not be used directly, but trough the <a class="el" href="classOgre_1_1LogManager.html">LogManager</a> class. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreLog_8h-source.html#l00058">58</a> of file <a class="el" href="OgreLog_8h-source.html">OgreLog.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1Loga0" doxytag="Ogre::Log::Log"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Log::Log </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>debugOutput</em> = true</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Usual constructor - called by <a class="el" href="classOgre_1_1LogManager.html">LogManager</a>.
<p>
<p>
Definition at line <a class="el" href="OgreLog_8cpp-source.html#l00033">33</a> of file <a class="el" href="OgreLog_8cpp-source.html">OgreLog.cpp</a>.
<p>
References <a class="el" href="namespaceOgre.html#a634a313">Ogre::LL_NORMAL</a>, <a class="el" href="OgreLog_8h-source.html#l00063">mDebugOut</a>, <a class="el" href="OgreLog_8h-source.html#l00061">mfpLog</a>, and <a class="el" href="OgreLog_8h-source.html#l00062">mLogLevel</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Loga1" doxytag="Ogre::Log::~Log"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Log::~Log </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Default destructor.
<p>
<p>
Definition at line <a class="el" href="OgreLog_8cpp-source.html#l00040">40</a> of file <a class="el" href="OgreLog_8cpp-source.html">OgreLog.cpp</a>.
<p>
References <a class="el" href="OgreLog_8h-source.html#l00061">mfpLog</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1Loga2" doxytag="Ogre::Log::logMessage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Log::logMessage </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>message</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a635">LogMessageLevel</a> </td>
<td class="mdname" nowrap> <em>lml</em> = LML_NORMAL</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classOgre_1_1Log.html">Log</a> a message to the debugger and to log file (the default is "<code>OGRE.log</code>"),.
<p>
<p>
Definition at line <a class="el" href="OgreLog_8cpp-source.html#l00045">45</a> of file <a class="el" href="OgreLog_8cpp-source.html">OgreLog.cpp</a>.
<p>
References <a class="el" href="OgreLog_8h-source.html#l00034">LOG_THRESHOLD</a>, <a class="el" href="OgreLog_8h-source.html#l00047">Ogre::LogMessageLevel</a>, <a class="el" href="OgreLog_8h-source.html#l00061">mfpLog</a>, and <a class="el" href="OgreLog_8h-source.html#l00062">mLogLevel</a>.
<p>
Referenced by <a class="el" href="OgreRenderSystemCapabilities_8cpp-source.html#l00045">Ogre::RenderSystemCapabilities::log</a>(), and <a class="el" href="OgreLogManager_8cpp-source.html#l00088">Ogre::LogManager::logMessage</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Loga3" doxytag="Ogre::Log::setLogDetail"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Log::setLogDetail </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a634">LoggingLevel</a> </td>
<td class="mdname1" valign="top" nowrap> <em>ll</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the level of the log detail.
<p>
<p>
Definition at line <a class="el" href="OgreLog_8cpp-source.html#l00066">66</a> of file <a class="el" href="OgreLog_8cpp-source.html">OgreLog.cpp</a>.
<p>
References <a class="el" href="OgreLog_8h-source.html#l00038">Ogre::LoggingLevel</a>, and <a class="el" href="OgreLog_8h-source.html#l00062">mLogLevel</a>.
<p>
Referenced by <a class="el" href="OgreLogManager_8cpp-source.html#l00105">Ogre::LogManager::setLogDetail</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1Logn2" doxytag="Ogre::Log::mDebugOut"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::Log::mDebugOut<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreLog_8h-source.html#l00063">63</a> of file <a class="el" href="OgreLog_8h-source.html">OgreLog.h</a>.
<p>
Referenced by <a class="el" href="OgreLog_8cpp-source.html#l00033">Log</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Logn0" doxytag="Ogre::Log::mfpLog"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::ofstream Ogre::Log::mfpLog<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreLog_8h-source.html#l00061">61</a> of file <a class="el" href="OgreLog_8h-source.html">OgreLog.h</a>.
<p>
Referenced by <a class="el" href="OgreLog_8cpp-source.html#l00033">Log</a>(), <a class="el" href="OgreLog_8cpp-source.html#l00045">logMessage</a>(), and <a class="el" href="OgreLog_8cpp-source.html#l00040">~Log</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Logn1" doxytag="Ogre::Log::mLogLevel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a634">LoggingLevel</a> Ogre::Log::mLogLevel<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreLog_8h-source.html#l00062">62</a> of file <a class="el" href="OgreLog_8h-source.html">OgreLog.h</a>.
<p>
Referenced by <a class="el" href="OgreLog_8cpp-source.html#l00033">Log</a>(), <a class="el" href="OgreLog_8cpp-source.html#l00045">logMessage</a>(), and <a class="el" href="OgreLog_8cpp-source.html#l00066">setLogDetail</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreLog_8h-source.html">OgreLog.h</a><li><a class="el" href="OgreLog_8cpp-source.html">OgreLog.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:18:02 2004
</p>
</body>
</html>
