\hypertarget{class_ogre_1_1_log}{}\section{Ogre\+:\+:Log Class Reference}
\label{class_ogre_1_1_log}\index{Ogre\+::\+Log@{Ogre\+::\+Log}}


{\ttfamily \#include $<$Ogre\+Log.\+h$>$}



Inheritance diagram for Ogre\+:\+:Log\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=143pt]{class_ogre_1_1_log__inherit__graph}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \hyperlink{class_ogre_1_1_log_1_1_stream}{Stream}
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_log_1_1_stream}{Stream} object which targets a log. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_log_a149aec94bfb4bcc03c947626f89916ad}{Log} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name, bool debug\+Output=true, bool suppress\+File\+Output=false)
\item 
\hyperlink{class_ogre_1_1_log_a7d36bb9b3f6f6890dd78ae503b6ce349}{$\sim$\+Log} ()
\item 
void \hyperlink{class_ogre_1_1_log_a4af71adcded1cde866f7163855c509cc}{add\+Listener} (\hyperlink{class_ogre_1_1_log_listener}{Log\+Listener} $\ast$listener)
\item 
\hyperlink{group___general_ga122d6319a25f910b8b1bf6fe52f91f6b}{Logging\+Level} \hyperlink{class_ogre_1_1_log_adeb20fbc595dac65a425d16178d68a4d}{get\+Log\+Detail} () const
\begin{DoxyCompactList}\small\item\em Gets the level of the log detail. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_log_af95c369bbc30d396b8ee6465e93b0223}{get\+Name} () const
\begin{DoxyCompactList}\small\item\em Return the name of the log. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_log_af90bdea2b5ac4b7f466c78124c49d644}{is\+Debug\+Output\+Enabled} () const
\begin{DoxyCompactList}\small\item\em Get whether debug output is enabled for this log. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_log_a43c0713b32a96a22afa67fdcb33ea652}{is\+File\+Output\+Suppressed} () const
\begin{DoxyCompactList}\small\item\em Get whether file output is suppressed for this log. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_log_a8adb9e21b32bf07e67dd5d6b8b9b504e}{is\+Time\+Stamp\+Enabled} () const
\begin{DoxyCompactList}\small\item\em Get whether time stamps are printed for this log. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_log_a41ad772d673872b2bbbf87f1f7c52eca}{log\+Message} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&message, \hyperlink{group___general_ga124456c1616299612ac9f46e7d69268d}{Log\+Message\+Level} lml=\hyperlink{group___general_gga124456c1616299612ac9f46e7d69268dab6d5702e6462875fcbc1b5aff2497d2e}{L\+M\+L\+\_\+\+N\+O\+R\+M\+AL}, bool mask\+Debug=false)
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_log}{Log} a message to the debugger and to log file (the default is \char`\"{}$<$code$>$\+O\+G\+R\+E.\+log$<$/code$>$\char`\"{}),. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_log_a84bf292947fed5a3760a78c391f0484c}{remove\+Listener} (\hyperlink{class_ogre_1_1_log_listener}{Log\+Listener} $\ast$listener)
\item 
void \hyperlink{class_ogre_1_1_log_ac374d185fe0498956e466f21916679d8}{set\+Debug\+Output\+Enabled} (bool debug\+Output)
\item 
void \hyperlink{class_ogre_1_1_log_a754bd94c0f311c333bf0eb4ae9bcdf8d}{set\+Log\+Detail} (\hyperlink{group___general_ga122d6319a25f910b8b1bf6fe52f91f6b}{Logging\+Level} ll)
\item 
void \hyperlink{class_ogre_1_1_log_a5fe96f6c6a32e8b80ce1af53d37bf2a9}{set\+Time\+Stamp\+Enabled} (bool time\+Stamp)
\item 
\hyperlink{class_ogre_1_1_log_1_1_stream}{Stream} \hyperlink{class_ogre_1_1_log_ad8296f1f29dbc5ba46188264fce84c4a}{stream} (\hyperlink{group___general_ga124456c1616299612ac9f46e7d69268d}{Log\+Message\+Level} lml=\hyperlink{group___general_gga124456c1616299612ac9f46e7d69268dab6d5702e6462875fcbc1b5aff2497d2e}{L\+M\+L\+\_\+\+N\+O\+R\+M\+AL}, bool mask\+Debug=false)
\begin{DoxyCompactList}\small\item\em Get a stream object targeting this log. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_log_ab0b6d2ed855ffc8e263ee311202eb7bd}{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
\begin{DoxyRemark}{Remarks}
\hyperlink{class_ogre_1_1_log}{Log} class for writing debug/log data to files. 
\end{DoxyRemark}
\begin{DoxyNote}{Note}
~\newline
Should not be used directly, but trough the \hyperlink{class_ogre_1_1_log_manager}{Log\+Manager} class. 
\end{DoxyNote}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_log_a149aec94bfb4bcc03c947626f89916ad}\label{class_ogre_1_1_log_a149aec94bfb4bcc03c947626f89916ad}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!Log@{Log}}
\index{Log@{Log}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{Log()}{Log()}}
{\footnotesize\ttfamily Ogre\+::\+Log\+::\+Log (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name,  }\item[{bool}]{debug\+Output = {\ttfamily true},  }\item[{bool}]{suppress\+File\+Output = {\ttfamily false} }\end{DoxyParamCaption})}

\begin{DoxyRemark}{Remarks}
Usual constructor -\/ called by \hyperlink{class_ogre_1_1_log_manager}{Log\+Manager}. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_log_a7d36bb9b3f6f6890dd78ae503b6ce349}\label{class_ogre_1_1_log_a7d36bb9b3f6f6890dd78ae503b6ce349}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!````~Log@{$\sim$\+Log}}
\index{````~Log@{$\sim$\+Log}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{$\sim$\+Log()}{~Log()}}
{\footnotesize\ttfamily Ogre\+::\+Log\+::$\sim$\+Log (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

\begin{DoxyRemark}{Remarks}
Default destructor. 
\end{DoxyRemark}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_log_af95c369bbc30d396b8ee6465e93b0223}\label{class_ogre_1_1_log_af95c369bbc30d396b8ee6465e93b0223}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!get\+Name@{get\+Name}}
\index{get\+Name@{get\+Name}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{get\+Name()}{getName()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Log\+::get\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Return the name of the log. 

\mbox{\Hypertarget{class_ogre_1_1_log_af90bdea2b5ac4b7f466c78124c49d644}\label{class_ogre_1_1_log_af90bdea2b5ac4b7f466c78124c49d644}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!is\+Debug\+Output\+Enabled@{is\+Debug\+Output\+Enabled}}
\index{is\+Debug\+Output\+Enabled@{is\+Debug\+Output\+Enabled}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{is\+Debug\+Output\+Enabled()}{isDebugOutputEnabled()}}
{\footnotesize\ttfamily bool Ogre\+::\+Log\+::is\+Debug\+Output\+Enabled (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get whether debug output is enabled for this log. 

\mbox{\Hypertarget{class_ogre_1_1_log_a43c0713b32a96a22afa67fdcb33ea652}\label{class_ogre_1_1_log_a43c0713b32a96a22afa67fdcb33ea652}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!is\+File\+Output\+Suppressed@{is\+File\+Output\+Suppressed}}
\index{is\+File\+Output\+Suppressed@{is\+File\+Output\+Suppressed}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{is\+File\+Output\+Suppressed()}{isFileOutputSuppressed()}}
{\footnotesize\ttfamily bool Ogre\+::\+Log\+::is\+File\+Output\+Suppressed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get whether file output is suppressed for this log. 

\mbox{\Hypertarget{class_ogre_1_1_log_a8adb9e21b32bf07e67dd5d6b8b9b504e}\label{class_ogre_1_1_log_a8adb9e21b32bf07e67dd5d6b8b9b504e}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!is\+Time\+Stamp\+Enabled@{is\+Time\+Stamp\+Enabled}}
\index{is\+Time\+Stamp\+Enabled@{is\+Time\+Stamp\+Enabled}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{is\+Time\+Stamp\+Enabled()}{isTimeStampEnabled()}}
{\footnotesize\ttfamily bool Ogre\+::\+Log\+::is\+Time\+Stamp\+Enabled (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get whether time stamps are printed for this log. 



References Ogre\+::\+L\+M\+L\+\_\+\+N\+O\+R\+M\+AL.

\mbox{\Hypertarget{class_ogre_1_1_log_a41ad772d673872b2bbbf87f1f7c52eca}\label{class_ogre_1_1_log_a41ad772d673872b2bbbf87f1f7c52eca}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!log\+Message@{log\+Message}}
\index{log\+Message@{log\+Message}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{log\+Message()}{logMessage()}}
{\footnotesize\ttfamily void Ogre\+::\+Log\+::log\+Message (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{message,  }\item[{\hyperlink{group___general_ga124456c1616299612ac9f46e7d69268d}{Log\+Message\+Level}}]{lml = {\ttfamily \hyperlink{group___general_gga124456c1616299612ac9f46e7d69268dab6d5702e6462875fcbc1b5aff2497d2e}{L\+M\+L\+\_\+\+N\+O\+R\+M\+AL}},  }\item[{bool}]{mask\+Debug = {\ttfamily false} }\end{DoxyParamCaption})}



\hyperlink{class_ogre_1_1_log}{Log} a message to the debugger and to log file (the default is \char`\"{}$<$code$>$\+O\+G\+R\+E.\+log$<$/code$>$\char`\"{}),. 



Referenced by Ogre\+::\+Log\+::\+Stream\+::operator$<$$<$(), and Ogre\+::\+Log\+::\+Stream\+::$\sim$\+Stream().

\mbox{\Hypertarget{class_ogre_1_1_log_ad8296f1f29dbc5ba46188264fce84c4a}\label{class_ogre_1_1_log_ad8296f1f29dbc5ba46188264fce84c4a}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!stream@{stream}}
\index{stream@{stream}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{stream()}{stream()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_log_1_1_stream}{Stream} Ogre\+::\+Log\+::stream (\begin{DoxyParamCaption}\item[{\hyperlink{group___general_ga124456c1616299612ac9f46e7d69268d}{Log\+Message\+Level}}]{lml = {\ttfamily \hyperlink{group___general_gga124456c1616299612ac9f46e7d69268dab6d5702e6462875fcbc1b5aff2497d2e}{L\+M\+L\+\_\+\+N\+O\+R\+M\+AL}},  }\item[{bool}]{mask\+Debug = {\ttfamily false} }\end{DoxyParamCaption})}



Get a stream object targeting this log. 

\mbox{\Hypertarget{class_ogre_1_1_log_ac374d185fe0498956e466f21916679d8}\label{class_ogre_1_1_log_ac374d185fe0498956e466f21916679d8}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!set\+Debug\+Output\+Enabled@{set\+Debug\+Output\+Enabled}}
\index{set\+Debug\+Output\+Enabled@{set\+Debug\+Output\+Enabled}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{set\+Debug\+Output\+Enabled()}{setDebugOutputEnabled()}}
{\footnotesize\ttfamily void Ogre\+::\+Log\+::set\+Debug\+Output\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{debug\+Output }\end{DoxyParamCaption})}

\begin{DoxyRemark}{Remarks}
Enable or disable outputting log messages to the debugger. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_log_a754bd94c0f311c333bf0eb4ae9bcdf8d}\label{class_ogre_1_1_log_a754bd94c0f311c333bf0eb4ae9bcdf8d}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!set\+Log\+Detail@{set\+Log\+Detail}}
\index{set\+Log\+Detail@{set\+Log\+Detail}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{set\+Log\+Detail()}{setLogDetail()}}
{\footnotesize\ttfamily void Ogre\+::\+Log\+::set\+Log\+Detail (\begin{DoxyParamCaption}\item[{\hyperlink{group___general_ga122d6319a25f910b8b1bf6fe52f91f6b}{Logging\+Level}}]{ll }\end{DoxyParamCaption})}

\begin{DoxyRemark}{Remarks}
Sets the level of the log detail. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_log_a5fe96f6c6a32e8b80ce1af53d37bf2a9}\label{class_ogre_1_1_log_a5fe96f6c6a32e8b80ce1af53d37bf2a9}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!set\+Time\+Stamp\+Enabled@{set\+Time\+Stamp\+Enabled}}
\index{set\+Time\+Stamp\+Enabled@{set\+Time\+Stamp\+Enabled}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{set\+Time\+Stamp\+Enabled()}{setTimeStampEnabled()}}
{\footnotesize\ttfamily void Ogre\+::\+Log\+::set\+Time\+Stamp\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{time\+Stamp }\end{DoxyParamCaption})}

\begin{DoxyRemark}{Remarks}
Enable or disable time stamps. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_log_adeb20fbc595dac65a425d16178d68a4d}\label{class_ogre_1_1_log_adeb20fbc595dac65a425d16178d68a4d}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!get\+Log\+Detail@{get\+Log\+Detail}}
\index{get\+Log\+Detail@{get\+Log\+Detail}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{get\+Log\+Detail()}{getLogDetail()}}
{\footnotesize\ttfamily \hyperlink{group___general_ga122d6319a25f910b8b1bf6fe52f91f6b}{Logging\+Level} Ogre\+::\+Log\+::get\+Log\+Detail (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets the level of the log detail. 

\mbox{\Hypertarget{class_ogre_1_1_log_a4af71adcded1cde866f7163855c509cc}\label{class_ogre_1_1_log_a4af71adcded1cde866f7163855c509cc}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!add\+Listener@{add\+Listener}}
\index{add\+Listener@{add\+Listener}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{add\+Listener()}{addListener()}}
{\footnotesize\ttfamily void Ogre\+::\+Log\+::add\+Listener (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_log_listener}{Log\+Listener} $\ast$}]{listener }\end{DoxyParamCaption})}

\begin{DoxyRemark}{Remarks}
Register a listener to this log 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em listener} & A valid listener derived class \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_log_a84bf292947fed5a3760a78c391f0484c}\label{class_ogre_1_1_log_a84bf292947fed5a3760a78c391f0484c}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!remove\+Listener@{remove\+Listener}}
\index{remove\+Listener@{remove\+Listener}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{remove\+Listener()}{removeListener()}}
{\footnotesize\ttfamily void Ogre\+::\+Log\+::remove\+Listener (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_log_listener}{Log\+Listener} $\ast$}]{listener }\end{DoxyParamCaption})}

\begin{DoxyRemark}{Remarks}
Unregister a listener from this log 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em listener} & A valid listener derived class \\
\hline
\end{DoxyParams}


\subsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_log_ab0b6d2ed855ffc8e263ee311202eb7bd}\label{class_ogre_1_1_log_ab0b6d2ed855ffc8e263ee311202eb7bd}} 
\index{Ogre\+::\+Log@{Ogre\+::\+Log}!O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX@{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}}
\index{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX@{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}!Ogre\+::\+Log@{Ogre\+::\+Log}}
\subsubsection{\texorpdfstring{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}{OGRE\_AUTO\_MUTEX}}
{\footnotesize\ttfamily Ogre\+::\+Log\+::\+O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_log_8h}{Ogre\+Log.\+h}\end{DoxyCompactItemize}
