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

Revision 657, 14.5 KB checked in by mattausch, 19 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::Log 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::Log Class Reference</h1><a class="el" href="classOgre_1_1Log.html">Log</a> class for writing debug/log data to files. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreLog_8h-source.html">OgreLog.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1Log-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Loga0">Log</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, bool debugOutput=true, bool suppressFileOutput=false)</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Usual constructor - called by <a class="el" href="classOgre_1_1LogManager.html">LogManager</a>.  <a href="#Ogre_1_1Loga0"></a><br><br></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Loga1">~Log</a> ()</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor.  <a href="#Ogre_1_1Loga1"></a><br><br></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Loga2">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>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1Log.html">Log</a> a message to the debugger and to log file (the default is "&lt;code&gt;OGRE.log&lt;/code&gt;"),.  <a href="#Ogre_1_1Loga2"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Loga3">setLogDetail</a> (<a class="el" href="namespaceOgre.html#a659">LoggingLevel</a> ll)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the level of the log detail.  <a href="#Ogre_1_1Loga3"></a><br><br></td></tr>
30<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>std::ofstream&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp0">mfpLog</a></td></tr>
32
33<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a659">LoggingLevel</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp1">mLogLevel</a></td></tr>
34
35<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp2">mDebugOut</a></td></tr>
36
37<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp3">mSuppressFile</a></td></tr>
38
39<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp4">mName</a></td></tr>
40
41</table>
42<hr><a name="_details"></a><h2>Detailed Description</h2>
43<a class="el" href="classOgre_1_1Log.html">Log</a> class for writing debug/log data to files.
44<p>
45<dl compact><dt><b>Note:</b></dt><dd><br>
46Should not be used directly, but trough the <a class="el" href="classOgre_1_1LogManager.html">LogManager</a> class. </dd></dl>
47
48<p>
49
50<p>
51Definition 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 &amp; Destructor Documentation</h2>
52<a class="anchor" name="Ogre_1_1Loga0" doxytag="Ogre::Log::Log" ></a><p>
53<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
54  <tr>
55    <td class="mdRow">
56      <table cellpadding="0" cellspacing="0" border="0">
57        <tr>
58          <td class="md" nowrap valign="top"> Ogre::Log::Log </td>
59          <td class="md" valign="top">(&nbsp;</td>
60          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
61          <td class="mdname" nowrap> <em>name</em>, </td>
62        </tr>
63        <tr>
64          <td class="md" nowrap align="right"></td>
65          <td></td>
66          <td class="md" nowrap>bool&nbsp;</td>
67          <td class="mdname" nowrap> <em>debugOutput</em> = true, </td>
68        </tr>
69        <tr>
70          <td class="md" nowrap align="right"></td>
71          <td></td>
72          <td class="md" nowrap>bool&nbsp;</td>
73          <td class="mdname" nowrap> <em>suppressFileOutput</em> = false</td>
74        </tr>
75        <tr>
76          <td></td>
77          <td class="md">)&nbsp;</td>
78          <td class="md" colspan="2"></td>
79        </tr>
80
81      </table>
82    </td>
83  </tr>
84</table>
85<table cellspacing=5 cellpadding=0 border=0>
86  <tr>
87    <td>
88      &nbsp;
89    </td>
90    <td>
91
92<p>
93Usual constructor - called by <a class="el" href="classOgre_1_1LogManager.html">LogManager</a>.
94<p>
95    </td>
96  </tr>
97</table>
98<a class="anchor" name="Ogre_1_1Loga1" doxytag="Ogre::Log::~Log" ></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"> Ogre::Log::~<a class="el" href="classOgre_1_1Log.html">Log</a> </td>
105          <td class="md" valign="top">(&nbsp;</td>
106          <td class="mdname1" valign="top" nowrap>          </td>
107          <td class="md" valign="top">&nbsp;)&nbsp;</td>
108          <td class="md" nowrap></td>
109        </tr>
110
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing=5 cellpadding=0 border=0>
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123Default destructor.
124<p>
125    </td>
126  </tr>
127</table>
128<hr><h2>Member Function Documentation</h2>
129<a class="anchor" name="Ogre_1_1Loga2" doxytag="Ogre::Log::logMessage" ></a><p>
130<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
131  <tr>
132    <td class="mdRow">
133      <table cellpadding="0" cellspacing="0" border="0">
134        <tr>
135          <td class="md" nowrap valign="top"> void Ogre::Log::logMessage </td>
136          <td class="md" valign="top">(&nbsp;</td>
137          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
138          <td class="mdname" nowrap> <em>message</em>, </td>
139        </tr>
140        <tr>
141          <td class="md" nowrap align="right"></td>
142          <td></td>
143          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a660">LogMessageLevel</a>&nbsp;</td>
144          <td class="mdname" nowrap> <em>lml</em> = LML_NORMAL, </td>
145        </tr>
146        <tr>
147          <td class="md" nowrap align="right"></td>
148          <td></td>
149          <td class="md" nowrap>bool&nbsp;</td>
150          <td class="mdname" nowrap> <em>maskDebug</em> = false</td>
151        </tr>
152        <tr>
153          <td></td>
154          <td class="md">)&nbsp;</td>
155          <td class="md" colspan="2"></td>
156        </tr>
157
158      </table>
159    </td>
160  </tr>
161</table>
162<table cellspacing=5 cellpadding=0 border=0>
163  <tr>
164    <td>
165      &nbsp;
166    </td>
167    <td>
168
169<p>
170<a class="el" href="classOgre_1_1Log.html">Log</a> a message to the debugger and to log file (the default is "&lt;code&gt;OGRE.log&lt;/code&gt;"),.
171<p>
172    </td>
173  </tr>
174</table>
175<a class="anchor" name="Ogre_1_1Loga3" doxytag="Ogre::Log::setLogDetail" ></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"> void Ogre::Log::setLogDetail </td>
182          <td class="md" valign="top">(&nbsp;</td>
183          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a659">LoggingLevel</a>&nbsp;</td>
184          <td class="mdname1" valign="top" nowrap> <em>ll</em>          </td>
185          <td class="md" valign="top">&nbsp;)&nbsp;</td>
186          <td class="md" nowrap></td>
187        </tr>
188
189      </table>
190    </td>
191  </tr>
192</table>
193<table cellspacing=5 cellpadding=0 border=0>
194  <tr>
195    <td>
196      &nbsp;
197    </td>
198    <td>
199
200<p>
201Sets the level of the log detail.
202<p>
203    </td>
204  </tr>
205</table>
206<hr><h2>Member Data Documentation</h2>
207<a class="anchor" name="Ogre_1_1Logp2" doxytag="Ogre::Log::mDebugOut" ></a><p>
208<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
209  <tr>
210    <td class="mdRow">
211      <table cellpadding="0" cellspacing="0" border="0">
212        <tr>
213          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp2">Ogre::Log::mDebugOut</a><code> [protected]</code>
214      </table>
215    </td>
216  </tr>
217</table>
218<table cellspacing=5 cellpadding=0 border=0>
219  <tr>
220    <td>
221      &nbsp;
222    </td>
223    <td>
224
225<p>
226
227<p>
228Definition 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>.    </td>
229  </tr>
230</table>
231<a class="anchor" name="Ogre_1_1Logp0" doxytag="Ogre::Log::mfpLog" ></a><p>
232<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
233  <tr>
234    <td class="mdRow">
235      <table cellpadding="0" cellspacing="0" border="0">
236        <tr>
237          <td class="md" nowrap valign="top"> std::ofstream <a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp0">Ogre::Log::mfpLog</a><code> [protected]</code>
238      </table>
239    </td>
240  </tr>
241</table>
242<table cellspacing=5 cellpadding=0 border=0>
243  <tr>
244    <td>
245      &nbsp;
246    </td>
247    <td>
248
249<p>
250
251<p>
252Definition 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>.    </td>
253  </tr>
254</table>
255<a class="anchor" name="Ogre_1_1Logp1" doxytag="Ogre::Log::mLogLevel" ></a><p>
256<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
257  <tr>
258    <td class="mdRow">
259      <table cellpadding="0" cellspacing="0" border="0">
260        <tr>
261          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a659">LoggingLevel</a> <a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp1">Ogre::Log::mLogLevel</a><code> [protected]</code>
262      </table>
263    </td>
264  </tr>
265</table>
266<table cellspacing=5 cellpadding=0 border=0>
267  <tr>
268    <td>
269      &nbsp;
270    </td>
271    <td>
272
273<p>
274
275<p>
276Definition 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>.    </td>
277  </tr>
278</table>
279<a class="anchor" name="Ogre_1_1Logp4" doxytag="Ogre::Log::mName" ></a><p>
280<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
281  <tr>
282    <td class="mdRow">
283      <table cellpadding="0" cellspacing="0" border="0">
284        <tr>
285          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp4">Ogre::Log::mName</a><code> [protected]</code>
286      </table>
287    </td>
288  </tr>
289</table>
290<table cellspacing=5 cellpadding=0 border=0>
291  <tr>
292    <td>
293      &nbsp;
294    </td>
295    <td>
296
297<p>
298
299<p>
300Definition at line <a class="el" href="OgreLog_8h-source.html#l00065">65</a> of file <a class="el" href="OgreLog_8h-source.html">OgreLog.h</a>.    </td>
301  </tr>
302</table>
303<a class="anchor" name="Ogre_1_1Logp3" doxytag="Ogre::Log::mSuppressFile" ></a><p>
304<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
305  <tr>
306    <td class="mdRow">
307      <table cellpadding="0" cellspacing="0" border="0">
308        <tr>
309          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Log.html#Ogre_1_1Logp3">Ogre::Log::mSuppressFile</a><code> [protected]</code>
310      </table>
311    </td>
312  </tr>
313</table>
314<table cellspacing=5 cellpadding=0 border=0>
315  <tr>
316    <td>
317      &nbsp;
318    </td>
319    <td>
320
321<p>
322
323<p>
324Definition at line <a class="el" href="OgreLog_8h-source.html#l00064">64</a> of file <a class="el" href="OgreLog_8h-source.html">OgreLog.h</a>.    </td>
325  </tr>
326</table>
327<hr>The documentation for this class was generated from the following file:<ul>
328<li><a class="el" href="OgreLog_8h-source.html">OgreLog.h</a></ul>
329<hr>
330<p>
331Copyright &copy; 2000-2005 by The OGRE Team<br />
332<!--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/>
333This 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/>
334                <!--/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#">
335                <Work rdf:about="">
336                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
337        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
338                </Work>
339                <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> -->
340
341Last modified Sun Feb 12 13:00:55 2006
342</p>
343</body>
344</html>
Note: See TracBrowser for help on using the repository browser.