source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1LogManager.html @ 657

Revision 657, 38.9 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::LogManager class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::LogManager Class Reference</h1>The log manager handles the creation and retrieval of logs for the application. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::LogManager:
16<p><center><img src="classOgre_1_1LogManager.png" usemap="#Ogre::LogManager_map" border="0" alt=""></center>
17<map name="Ogre::LogManager_map">
18<area href="classOgre_1_1Singleton.html" alt="Ogre::Singleton< LogManager >" shape="rect" coords="0,0,195,24">
19</map>
20<a href="classOgre_1_1LogManager-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera0">LogManager</a> ()</td></tr>
24
25<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera1">~LogManager</a> ()</td></tr>
26
27<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera2">addListener</a> (<a class="el" href="classOgre_1_1LogListener.html">LogListener</a> *listener)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new listener for the logging system.  <a href="#Ogre_1_1LogManagera2"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera3">removeListener</a> (<a class="el" href="classOgre_1_1LogListener.html">LogListener</a> *listener)</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a previously registered listener again, and returns ownership of the listener to the caller, who is responsible for destroying the listener again.  <a href="#Ogre_1_1LogManagera3"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Log.html">Log</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera4">createLog</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, bool defaultLog=false, bool debuggerOutput=true, bool suppressFileOutput=false)</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new log with the given name.  <a href="#Ogre_1_1LogManagera4"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Log.html">Log</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera5">getLog</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name)</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a log managed by this class.  <a href="#Ogre_1_1LogManagera5"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Log.html">Log</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera6">getDefaultLog</a> ()</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a pointer to the default log.  <a href="#Ogre_1_1LogManagera6"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Log.html">Log</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera7">setDefaultLog</a> (<a class="el" href="classOgre_1_1Log.html">Log</a> *newLog)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the passed in log as the default log.  <a href="#Ogre_1_1LogManagera7"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera8">logMessage</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;message, <a class="el" href="namespaceOgre.html#a660">LogMessageLevel</a> lml=LML_NORMAL, bool maskDebug=false)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1Log.html">Log</a> a message to the default log.  <a href="#Ogre_1_1LogManagera8"></a><br><br></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera9">logMessage</a> (<a class="el" href="namespaceOgre.html#a660">LogMessageLevel</a> lml, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;message, bool maskDebug=false)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1Log.html">Log</a> a message to the default log (signature for backward compatibility).  <a href="#Ogre_1_1LogManagera9"></a><br><br></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagera10">setLogDetail</a> (<a class="el" href="namespaceOgre.html#a659">LoggingLevel</a> ll)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the level of detail of the default log.  <a href="#Ogre_1_1LogManagera10"></a><br><br></td></tr>
54<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LogManager.html">LogManager</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagere0">getSingleton</a> (void)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.  <a href="#Ogre_1_1LogManagere0"></a><br><br></td></tr>
58<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LogManager.html">LogManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagere1">getSingletonPtr</a> (void)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.  <a href="#Ogre_1_1LogManagere1"></a><br><br></td></tr>
61<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a426">String</a>,<br>
63 <a class="el" href="classOgre_1_1Log.html">Log</a> *, std::less&lt; <a class="el" href="namespaceOgre.html#a426">String</a> &gt; &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerx0">LogList</a></td></tr>
64
65<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classOgre_1_1LogListener.html">LogListener</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerx1">LogListenerList</a></td></tr>
66
67<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerb0">_routeMessage</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;message, <a class="el" href="namespaceOgre.html#a660">LogMessageLevel</a> lml=LML_NORMAL, bool maskDebug=false)</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal helper method to reroute logging messages to the new listener system, while maintaining full backward compatiblity.  <a href="#Ogre_1_1LogManagerb0"></a><br><br></td></tr>
71<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
72<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerx0">LogList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerp0">mLogs</a></td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A list of all the logs the manager can access.  <a href="#Ogre_1_1LogManagerp0"></a><br><br></td></tr>
75<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Log.html">Log</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerp1">mDefaultLog</a></td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default log to which output is done.  <a href="#Ogre_1_1LogManagerp1"></a><br><br></td></tr>
78<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerx1">LogListenerList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerp2">mListeners</a></td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A list of all registered external log listeners.  <a href="#Ogre_1_1LogManagerp2"></a><br><br></td></tr>
81<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
82<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LogManager.html">LogManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a></td></tr>
83
84<tr><td colspan=2><br><h2>Friends</h2></td></tr>
85<tr><td class="memItemLeft" nowrap align=right valign=top>class&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagern0">Log</a></td></tr>
86
87</table>
88<hr><a name="_details"></a><h2>Detailed Description</h2>
89The log manager handles the creation and retrieval of logs for the application.
90<p>
91<dl compact><dt><b>Remarks:</b></dt><dd>This class will create new log files and will retrieve instances of existing ones. Other classes wishing to log output can either create a fresh log or retrieve an existing one to output to. One log is the default log, and is the one written to when the logging methods of this class are called. </dd></dl>
92<dl compact><dt><b></b></dt><dd>By default, <a class="el" href="classOgre_1_1Root.html">Root</a> will instantiate a <a class="el" href="classOgre_1_1LogManager.html">LogManager</a> (which becomes the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> instance) on construction, and will create a default log based on the <a class="el" href="classOgre_1_1Root.html">Root</a> construction parameters. If you want more control, for example redirecting log output right from the start or suppressing debug output, you need to create a <a class="el" href="classOgre_1_1LogManager.html">LogManager</a> yourself before creating a <a class="el" href="classOgre_1_1Root.html">Root</a> instance, then create a default log. <a class="el" href="classOgre_1_1Root.html">Root</a> will detect that you've created one yourself and won't create one of its own, thus using all your logging preferences from the first instance. </dd></dl>
93
94<p>
95
96<p>
97Definition at line <a class="el" href="OgreLogManager_8h-source.html#l00071">71</a> of file <a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>.<hr><h2>Member Typedef Documentation</h2>
98<a class="anchor" name="Ogre_1_1LogManagerx0" doxytag="Ogre::LogManager::LogList" ></a><p>
99<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
100  <tr>
101    <td class="mdRow">
102      <table cellpadding="0" cellspacing="0" border="0">
103        <tr>
104          <td class="md" nowrap valign="top"> typedef std::map&lt;<a class="el" href="namespaceOgre.html#a426">String</a>, <a class="el" href="classOgre_1_1Log.html">Log</a>*, std::less&lt;<a class="el" href="namespaceOgre.html#a426">String</a>&gt; &gt; <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerx0">Ogre::LogManager::LogList</a><code> [protected]</code>
105      </table>
106    </td>
107  </tr>
108</table>
109<table cellspacing=5 cellpadding=0 border=0>
110  <tr>
111    <td>
112      &nbsp;
113    </td>
114    <td>
115
116<p>
117
118<p>
119Definition at line <a class="el" href="OgreLogManager_8h-source.html#l00085">85</a> of file <a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>.    </td>
120  </tr>
121</table>
122<a class="anchor" name="Ogre_1_1LogManagerx1" doxytag="Ogre::LogManager::LogListenerList" ></a><p>
123<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
124  <tr>
125    <td class="mdRow">
126      <table cellpadding="0" cellspacing="0" border="0">
127        <tr>
128          <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classOgre_1_1LogListener.html">LogListener</a>*&gt; <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerx1">Ogre::LogManager::LogListenerList</a><code> [protected]</code>
129      </table>
130    </td>
131  </tr>
132</table>
133<table cellspacing=5 cellpadding=0 border=0>
134  <tr>
135    <td>
136      &nbsp;
137    </td>
138    <td>
139
140<p>
141
142<p>
143Definition at line <a class="el" href="OgreLogManager_8h-source.html#l00086">86</a> of file <a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>.    </td>
144  </tr>
145</table>
146<hr><h2>Constructor &amp; Destructor Documentation</h2>
147<a class="anchor" name="Ogre_1_1LogManagera0" doxytag="Ogre::LogManager::LogManager" ></a><p>
148<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
149  <tr>
150    <td class="mdRow">
151      <table cellpadding="0" cellspacing="0" border="0">
152        <tr>
153          <td class="md" nowrap valign="top"> Ogre::LogManager::LogManager </td>
154          <td class="md" valign="top">(&nbsp;</td>
155          <td class="mdname1" valign="top" nowrap>          </td>
156          <td class="md" valign="top">&nbsp;)&nbsp;</td>
157          <td class="md" nowrap></td>
158        </tr>
159
160      </table>
161    </td>
162  </tr>
163</table>
164<table cellspacing=5 cellpadding=0 border=0>
165  <tr>
166    <td>
167      &nbsp;
168    </td>
169    <td>
170
171<p>
172    </td>
173  </tr>
174</table>
175<a class="anchor" name="Ogre_1_1LogManagera1" doxytag="Ogre::LogManager::~LogManager" ></a><p>
176<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
177  <tr>
178    <td class="mdRow">
179      <table cellpadding="0" cellspacing="0" border="0">
180        <tr>
181          <td class="md" nowrap valign="top"> Ogre::LogManager::~<a class="el" href="classOgre_1_1LogManager.html">LogManager</a> </td>
182          <td class="md" valign="top">(&nbsp;</td>
183          <td class="mdname1" valign="top" nowrap>          </td>
184          <td class="md" valign="top">&nbsp;)&nbsp;</td>
185          <td class="md" nowrap></td>
186        </tr>
187
188      </table>
189    </td>
190  </tr>
191</table>
192<table cellspacing=5 cellpadding=0 border=0>
193  <tr>
194    <td>
195      &nbsp;
196    </td>
197    <td>
198
199<p>
200    </td>
201  </tr>
202</table>
203<hr><h2>Member Function Documentation</h2>
204<a class="anchor" name="Ogre_1_1LogManagerb0" doxytag="Ogre::LogManager::_routeMessage" ></a><p>
205<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
206  <tr>
207    <td class="mdRow">
208      <table cellpadding="0" cellspacing="0" border="0">
209        <tr>
210          <td class="md" nowrap valign="top"> void Ogre::LogManager::_routeMessage </td>
211          <td class="md" valign="top">(&nbsp;</td>
212          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
213          <td class="mdname" nowrap> <em>name</em>, </td>
214        </tr>
215        <tr>
216          <td class="md" nowrap align="right"></td>
217          <td></td>
218          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
219          <td class="mdname" nowrap> <em>message</em>, </td>
220        </tr>
221        <tr>
222          <td class="md" nowrap align="right"></td>
223          <td></td>
224          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a660">LogMessageLevel</a>&nbsp;</td>
225          <td class="mdname" nowrap> <em>lml</em> = LML_NORMAL, </td>
226        </tr>
227        <tr>
228          <td class="md" nowrap align="right"></td>
229          <td></td>
230          <td class="md" nowrap>bool&nbsp;</td>
231          <td class="mdname" nowrap> <em>maskDebug</em> = false</td>
232        </tr>
233        <tr>
234          <td></td>
235          <td class="md">)&nbsp;</td>
236          <td class="md" colspan="2"><code> [protected]</code></td>
237        </tr>
238
239      </table>
240    </td>
241  </tr>
242</table>
243<table cellspacing=5 cellpadding=0 border=0>
244  <tr>
245    <td>
246      &nbsp;
247    </td>
248    <td>
249
250<p>
251Internal helper method to reroute logging messages to the new listener system, while maintaining full backward compatiblity.
252<p>
253    </td>
254  </tr>
255</table>
256<a class="anchor" name="Ogre_1_1LogManagera2" doxytag="Ogre::LogManager::addListener" ></a><p>
257<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
258  <tr>
259    <td class="mdRow">
260      <table cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td class="md" nowrap valign="top"> void Ogre::LogManager::addListener </td>
263          <td class="md" valign="top">(&nbsp;</td>
264          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1LogListener.html">LogListener</a> *&nbsp;</td>
265          <td class="mdname1" valign="top" nowrap> <em>listener</em>          </td>
266          <td class="md" valign="top">&nbsp;)&nbsp;</td>
267          <td class="md" nowrap></td>
268        </tr>
269
270      </table>
271    </td>
272  </tr>
273</table>
274<table cellspacing=5 cellpadding=0 border=0>
275  <tr>
276    <td>
277      &nbsp;
278    </td>
279    <td>
280
281<p>
282Adds a new listener for the logging system.
283<p>
284<a class="el" href="namespaceOgre.html">Ogre</a> does not assume ownership and does not destroy the listener at application shutdown.    </td>
285  </tr>
286</table>
287<a class="anchor" name="Ogre_1_1LogManagera4" doxytag="Ogre::LogManager::createLog" ></a><p>
288<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Log.html">Log</a>* Ogre::LogManager::createLog </td>
294          <td class="md" valign="top">(&nbsp;</td>
295          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
296          <td class="mdname" nowrap> <em>name</em>, </td>
297        </tr>
298        <tr>
299          <td class="md" nowrap align="right"></td>
300          <td></td>
301          <td class="md" nowrap>bool&nbsp;</td>
302          <td class="mdname" nowrap> <em>defaultLog</em> = false, </td>
303        </tr>
304        <tr>
305          <td class="md" nowrap align="right"></td>
306          <td></td>
307          <td class="md" nowrap>bool&nbsp;</td>
308          <td class="mdname" nowrap> <em>debuggerOutput</em> = true, </td>
309        </tr>
310        <tr>
311          <td class="md" nowrap align="right"></td>
312          <td></td>
313          <td class="md" nowrap>bool&nbsp;</td>
314          <td class="mdname" nowrap> <em>suppressFileOutput</em> = false</td>
315        </tr>
316        <tr>
317          <td></td>
318          <td class="md">)&nbsp;</td>
319          <td class="md" colspan="2"></td>
320        </tr>
321
322      </table>
323    </td>
324  </tr>
325</table>
326<table cellspacing=5 cellpadding=0 border=0>
327  <tr>
328    <td>
329      &nbsp;
330    </td>
331    <td>
332
333<p>
334Creates a new log with the given name.
335<p>
336<dl compact><dt><b>Parameters:</b></dt><dd>
337  <table border="0" cellspacing="2" cellpadding="0">
338    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name to give the log e.g. 'Ogre.log' </td></tr>
339    <tr><td valign=top><em>defaultLog</em>&nbsp;</td><td>If true, this is the default log output will be sent to if the generic logging methods on this class are used. The first log created is always the default log unless this parameter is set. </td></tr>
340    <tr><td valign=top><em>debuggerOutput</em>&nbsp;</td><td>If true, output to this log will also be routed to the debugger's output window. </td></tr>
341    <tr><td valign=top><em>suppressFileOutput</em>&nbsp;</td><td>If true, this is a logical rather than a physical log and no file output will be written. If you do this you should register a <a class="el" href="classOgre_1_1LogListener.html">LogListener</a> so log output is not lost. </td></tr>
342  </table>
343</dl>
344    </td>
345  </tr>
346</table>
347<a class="anchor" name="Ogre_1_1LogManagera6" doxytag="Ogre::LogManager::getDefaultLog" ></a><p>
348<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
349  <tr>
350    <td class="mdRow">
351      <table cellpadding="0" cellspacing="0" border="0">
352        <tr>
353          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Log.html">Log</a>* Ogre::LogManager::getDefaultLog </td>
354          <td class="md" valign="top">(&nbsp;</td>
355          <td class="mdname1" valign="top" nowrap>          </td>
356          <td class="md" valign="top">&nbsp;)&nbsp;</td>
357          <td class="md" nowrap></td>
358        </tr>
359
360      </table>
361    </td>
362  </tr>
363</table>
364<table cellspacing=5 cellpadding=0 border=0>
365  <tr>
366    <td>
367      &nbsp;
368    </td>
369    <td>
370
371<p>
372Returns a pointer to the default log.
373<p>
374    </td>
375  </tr>
376</table>
377<a class="anchor" name="Ogre_1_1LogManagera5" doxytag="Ogre::LogManager::getLog" ></a><p>
378<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
379  <tr>
380    <td class="mdRow">
381      <table cellpadding="0" cellspacing="0" border="0">
382        <tr>
383          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Log.html">Log</a>* Ogre::LogManager::getLog </td>
384          <td class="md" valign="top">(&nbsp;</td>
385          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
386          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
387          <td class="md" valign="top">&nbsp;)&nbsp;</td>
388          <td class="md" nowrap></td>
389        </tr>
390
391      </table>
392    </td>
393  </tr>
394</table>
395<table cellspacing=5 cellpadding=0 border=0>
396  <tr>
397    <td>
398      &nbsp;
399    </td>
400    <td>
401
402<p>
403Retrieves a log managed by this class.
404<p>
405    </td>
406  </tr>
407</table>
408<a class="anchor" name="Ogre_1_1LogManagere0" doxytag="Ogre::LogManager::getSingleton" ></a><p>
409<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
410  <tr>
411    <td class="mdRow">
412      <table cellpadding="0" cellspacing="0" border="0">
413        <tr>
414          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LogManager.html">LogManager</a>&amp; Ogre::LogManager::getSingleton </td>
415          <td class="md" valign="top">(&nbsp;</td>
416          <td class="md" nowrap valign="top">void&nbsp;</td>
417          <td class="mdname1" valign="top" nowrap>          </td>
418          <td class="md" valign="top">&nbsp;)&nbsp;</td>
419          <td class="md" nowrap><code> [static]</code></td>
420        </tr>
421
422      </table>
423    </td>
424  </tr>
425</table>
426<table cellspacing=5 cellpadding=0 border=0>
427  <tr>
428    <td>
429      &nbsp;
430    </td>
431    <td>
432
433<p>
434Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.
435<p>
436<dl compact><dt><b>Remarks:</b></dt><dd>Why do we do this? Well, it's because the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> template to work, but we actually only want it compiled into the implementation of the class based on the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a>, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. </dd></dl>
437<dl compact><dt><b></b></dt><dd>This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors. </dd></dl>
438
439<p>
440Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone0">Ogre::Singleton&lt; LogManager &gt;</a>.    </td>
441  </tr>
442</table>
443<a class="anchor" name="Ogre_1_1LogManagere1" doxytag="Ogre::LogManager::getSingletonPtr" ></a><p>
444<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
445  <tr>
446    <td class="mdRow">
447      <table cellpadding="0" cellspacing="0" border="0">
448        <tr>
449          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LogManager.html">LogManager</a>* Ogre::LogManager::getSingletonPtr </td>
450          <td class="md" valign="top">(&nbsp;</td>
451          <td class="md" nowrap valign="top">void&nbsp;</td>
452          <td class="mdname1" valign="top" nowrap>          </td>
453          <td class="md" valign="top">&nbsp;)&nbsp;</td>
454          <td class="md" nowrap><code> [static]</code></td>
455        </tr>
456
457      </table>
458    </td>
459  </tr>
460</table>
461<table cellspacing=5 cellpadding=0 border=0>
462  <tr>
463    <td>
464      &nbsp;
465    </td>
466    <td>
467
468<p>
469Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.
470<p>
471<dl compact><dt><b>Remarks:</b></dt><dd>Why do we do this? Well, it's because the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> template to work, but we actually only want it compiled into the implementation of the class based on the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a>, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. </dd></dl>
472<dl compact><dt><b></b></dt><dd>This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors. </dd></dl>
473
474<p>
475Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone1">Ogre::Singleton&lt; LogManager &gt;</a>.    </td>
476  </tr>
477</table>
478<a class="anchor" name="Ogre_1_1LogManagera9" doxytag="Ogre::LogManager::logMessage" ></a><p>
479<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
480  <tr>
481    <td class="mdRow">
482      <table cellpadding="0" cellspacing="0" border="0">
483        <tr>
484          <td class="md" nowrap valign="top"> void Ogre::LogManager::logMessage </td>
485          <td class="md" valign="top">(&nbsp;</td>
486          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a660">LogMessageLevel</a>&nbsp;</td>
487          <td class="mdname" nowrap> <em>lml</em>, </td>
488        </tr>
489        <tr>
490          <td class="md" nowrap align="right"></td>
491          <td></td>
492          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
493          <td class="mdname" nowrap> <em>message</em>, </td>
494        </tr>
495        <tr>
496          <td class="md" nowrap align="right"></td>
497          <td></td>
498          <td class="md" nowrap>bool&nbsp;</td>
499          <td class="mdname" nowrap> <em>maskDebug</em> = false</td>
500        </tr>
501        <tr>
502          <td></td>
503          <td class="md">)&nbsp;</td>
504          <td class="md" colspan="2"></td>
505        </tr>
506
507      </table>
508    </td>
509  </tr>
510</table>
511<table cellspacing=5 cellpadding=0 border=0>
512  <tr>
513    <td>
514      &nbsp;
515    </td>
516    <td>
517
518<p>
519<a class="el" href="classOgre_1_1Log.html">Log</a> a message to the default log (signature for backward compatibility).
520<p>
521
522<p>
523Definition at line <a class="el" href="OgreLogManager_8h-source.html#l00152">152</a> of file <a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>.
524<p>
525References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
526  </tr>
527</table>
528<a class="anchor" name="Ogre_1_1LogManagera8" doxytag="Ogre::LogManager::logMessage" ></a><p>
529<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
530  <tr>
531    <td class="mdRow">
532      <table cellpadding="0" cellspacing="0" border="0">
533        <tr>
534          <td class="md" nowrap valign="top"> void Ogre::LogManager::logMessage </td>
535          <td class="md" valign="top">(&nbsp;</td>
536          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
537          <td class="mdname" nowrap> <em>message</em>, </td>
538        </tr>
539        <tr>
540          <td class="md" nowrap align="right"></td>
541          <td></td>
542          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a660">LogMessageLevel</a>&nbsp;</td>
543          <td class="mdname" nowrap> <em>lml</em> = LML_NORMAL, </td>
544        </tr>
545        <tr>
546          <td class="md" nowrap align="right"></td>
547          <td></td>
548          <td class="md" nowrap>bool&nbsp;</td>
549          <td class="mdname" nowrap> <em>maskDebug</em> = false</td>
550        </tr>
551        <tr>
552          <td></td>
553          <td class="md">)&nbsp;</td>
554          <td class="md" colspan="2"></td>
555        </tr>
556
557      </table>
558    </td>
559  </tr>
560</table>
561<table cellspacing=5 cellpadding=0 border=0>
562  <tr>
563    <td>
564      &nbsp;
565    </td>
566    <td>
567
568<p>
569<a class="el" href="classOgre_1_1Log.html">Log</a> a message to the default log.
570<p>
571    </td>
572  </tr>
573</table>
574<a class="anchor" name="Ogre_1_1LogManagera3" doxytag="Ogre::LogManager::removeListener" ></a><p>
575<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
576  <tr>
577    <td class="mdRow">
578      <table cellpadding="0" cellspacing="0" border="0">
579        <tr>
580          <td class="md" nowrap valign="top"> void Ogre::LogManager::removeListener </td>
581          <td class="md" valign="top">(&nbsp;</td>
582          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1LogListener.html">LogListener</a> *&nbsp;</td>
583          <td class="mdname1" valign="top" nowrap> <em>listener</em>          </td>
584          <td class="md" valign="top">&nbsp;)&nbsp;</td>
585          <td class="md" nowrap></td>
586        </tr>
587
588      </table>
589    </td>
590  </tr>
591</table>
592<table cellspacing=5 cellpadding=0 border=0>
593  <tr>
594    <td>
595      &nbsp;
596    </td>
597    <td>
598
599<p>
600Removes a previously registered listener again, and returns ownership of the listener to the caller, who is responsible for destroying the listener again.
601<p>
602    </td>
603  </tr>
604</table>
605<a class="anchor" name="Ogre_1_1LogManagera7" doxytag="Ogre::LogManager::setDefaultLog" ></a><p>
606<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
607  <tr>
608    <td class="mdRow">
609      <table cellpadding="0" cellspacing="0" border="0">
610        <tr>
611          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Log.html">Log</a>* Ogre::LogManager::setDefaultLog </td>
612          <td class="md" valign="top">(&nbsp;</td>
613          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Log.html">Log</a> *&nbsp;</td>
614          <td class="mdname1" valign="top" nowrap> <em>newLog</em>          </td>
615          <td class="md" valign="top">&nbsp;)&nbsp;</td>
616          <td class="md" nowrap></td>
617        </tr>
618
619      </table>
620    </td>
621  </tr>
622</table>
623<table cellspacing=5 cellpadding=0 border=0>
624  <tr>
625    <td>
626      &nbsp;
627    </td>
628    <td>
629
630<p>
631Sets the passed in log as the default log.
632<p>
633<dl compact><dt><b>Returns:</b></dt><dd>The previous default log. </dd></dl>
634    </td>
635  </tr>
636</table>
637<a class="anchor" name="Ogre_1_1LogManagera10" doxytag="Ogre::LogManager::setLogDetail" ></a><p>
638<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
639  <tr>
640    <td class="mdRow">
641      <table cellpadding="0" cellspacing="0" border="0">
642        <tr>
643          <td class="md" nowrap valign="top"> void Ogre::LogManager::setLogDetail </td>
644          <td class="md" valign="top">(&nbsp;</td>
645          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a659">LoggingLevel</a>&nbsp;</td>
646          <td class="mdname1" valign="top" nowrap> <em>ll</em>          </td>
647          <td class="md" valign="top">&nbsp;)&nbsp;</td>
648          <td class="md" nowrap></td>
649        </tr>
650
651      </table>
652    </td>
653  </tr>
654</table>
655<table cellspacing=5 cellpadding=0 border=0>
656  <tr>
657    <td>
658      &nbsp;
659    </td>
660    <td>
661
662<p>
663Sets the level of detail of the default log.
664<p>
665    </td>
666  </tr>
667</table>
668<hr><h2>Friends And Related Function Documentation</h2>
669<a class="anchor" name="Ogre_1_1LogManagern0" doxytag="Ogre::LogManager::Log" ></a><p>
670<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
671  <tr>
672    <td class="mdRow">
673      <table cellpadding="0" cellspacing="0" border="0">
674        <tr>
675          <td class="md" nowrap valign="top"> friend class <a class="el" href="classOgre_1_1Log.html">Log</a><code> [friend]</code>
676      </table>
677    </td>
678  </tr>
679</table>
680<table cellspacing=5 cellpadding=0 border=0>
681  <tr>
682    <td>
683      &nbsp;
684    </td>
685    <td>
686
687<p>
688
689<p>
690Definition at line <a class="el" href="OgreLogManager_8h-source.html#l00073">73</a> of file <a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>.    </td>
691  </tr>
692</table>
693<hr><h2>Member Data Documentation</h2>
694<a class="anchor" name="Ogre_1_1LogManagerp1" doxytag="Ogre::LogManager::mDefaultLog" ></a><p>
695<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
696  <tr>
697    <td class="mdRow">
698      <table cellpadding="0" cellspacing="0" border="0">
699        <tr>
700          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Log.html">Log</a>* <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerp1">Ogre::LogManager::mDefaultLog</a><code> [protected]</code>
701      </table>
702    </td>
703  </tr>
704</table>
705<table cellspacing=5 cellpadding=0 border=0>
706  <tr>
707    <td>
708      &nbsp;
709    </td>
710    <td>
711
712<p>
713The default log to which output is done.
714<p>
715
716<p>
717Definition at line <a class="el" href="OgreLogManager_8h-source.html#l00092">92</a> of file <a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>.    </td>
718  </tr>
719</table>
720<a class="anchor" name="Ogre_1_1LogManagerp2" doxytag="Ogre::LogManager::mListeners" ></a><p>
721<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
722  <tr>
723    <td class="mdRow">
724      <table cellpadding="0" cellspacing="0" border="0">
725        <tr>
726          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerx1">LogListenerList</a> <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerp2">Ogre::LogManager::mListeners</a><code> [protected]</code>
727      </table>
728    </td>
729  </tr>
730</table>
731<table cellspacing=5 cellpadding=0 border=0>
732  <tr>
733    <td>
734      &nbsp;
735    </td>
736    <td>
737
738<p>
739A list of all registered external log listeners.
740<p>
741
742<p>
743Definition at line <a class="el" href="OgreLogManager_8h-source.html#l00095">95</a> of file <a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>.    </td>
744  </tr>
745</table>
746<a class="anchor" name="Ogre_1_1LogManagerp0" doxytag="Ogre::LogManager::mLogs" ></a><p>
747<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
748  <tr>
749    <td class="mdRow">
750      <table cellpadding="0" cellspacing="0" border="0">
751        <tr>
752          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerx0">LogList</a> <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagerp0">Ogre::LogManager::mLogs</a><code> [protected]</code>
753      </table>
754    </td>
755  </tr>
756</table>
757<table cellspacing=5 cellpadding=0 border=0>
758  <tr>
759    <td>
760      &nbsp;
761    </td>
762    <td>
763
764<p>
765A list of all the logs the manager can access.
766<p>
767
768<p>
769Definition at line <a class="el" href="OgreLogManager_8h-source.html#l00089">89</a> of file <a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a>.    </td>
770  </tr>
771</table>
772<a class="anchor" name="Ogre_1_1Singletont0" doxytag="Ogre::LogManager::ms_Singleton" ></a><p>
773<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
774  <tr>
775    <td class="mdRow">
776      <table cellpadding="0" cellspacing="0" border="0">
777        <tr>
778          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LogManager.html">LogManager</a> * <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; <a class="el" href="classOgre_1_1LogManager.html">LogManager</a>  &gt;::<a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a><code> [static, protected, inherited]</code>
779      </table>
780    </td>
781  </tr>
782</table>
783<table cellspacing=5 cellpadding=0 border=0>
784  <tr>
785    <td>
786      &nbsp;
787    </td>
788    <td>
789
790<p>
791
792<p>
793Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00054">54</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
794  </tr>
795</table>
796<hr>The documentation for this class was generated from the following file:<ul>
797<li><a class="el" href="OgreLogManager_8h-source.html">OgreLogManager.h</a></ul>
798<hr>
799<p>
800Copyright &copy; 2000-2005 by The OGRE Team<br />
801<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
802This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
803                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
804                <Work rdf:about="">
805                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
806        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
807                </Work>
808                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
809
810Last modified Sun Feb 12 13:00:56 2006
811</p>
812</body>
813</html>
Note: See TracBrowser for help on using the repository browser.