\hypertarget{class_b_m_a_log}{}\section{B\+M\+A\+Log Class Reference}
\label{class_b_m_a_log}\index{B\+M\+A\+Log@{B\+M\+A\+Log}}


{\ttfamily \#include $<$B\+M\+A\+Log.\+h$>$}



Inheritance diagram for B\+M\+A\+Log\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=260pt]{class_b_m_a_log__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for B\+M\+A\+Log\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_b_m_a_log__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_b_m_a_log_a66b78b476e77c269d61776386be97c65}{B\+M\+A\+Log} (\hyperlink{class_b_m_a_console_server}{B\+M\+A\+Console\+Server} $\ast$\hyperlink{class_b_m_a_log_a3d5d2e2b15c135159b42c7e1f0dcc7e1}{console\+Server})
\item 
\hyperlink{class_b_m_a_log_aa85718158f606f2b0dbb7f6b7f5cc475}{B\+M\+A\+Log} (\hyperlink{class_b_m_a_file}{B\+M\+A\+File} $\ast$\hyperlink{class_b_m_a_log_aa5789774e19266041e1211c9c386ed21}{log\+File})
\item 
\hyperlink{class_b_m_a_log_ad14bf19745d33be21431f8c0133d9ffe}{B\+M\+A\+Log} (int level)
\item 
\hyperlink{class_b_m_a_log_a443ae6142ef92a8ed4c9af5db57d55a0}{$\sim$\+B\+M\+A\+Log} ()
\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{class_b_m_a_log_a5a125afce22d850ec4835b1400486db2}\label{class_b_m_a_log_a5a125afce22d850ec4835b1400486db2}} 
bool {\bfseries output} = false
\end{DoxyCompactItemize}
\subsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{class_b_m_a_console_server}{B\+M\+A\+Console\+Server} $\ast$ \hyperlink{class_b_m_a_log_a3d5d2e2b15c135159b42c7e1f0dcc7e1}{console\+Server} = N\+U\+LL
\item 
static \hyperlink{class_b_m_a_file}{B\+M\+A\+File} $\ast$ \hyperlink{class_b_m_a_log_aa5789774e19266041e1211c9c386ed21}{log\+File} = N\+U\+LL
\item 
static int \hyperlink{class_b_m_a_log_a0d53862e6749badb4397a0fd8ce25a81}{seq} = 0
\end{DoxyCompactItemize}


\subsection{Detailed Description}
\hyperlink{class_b_m_a_log}{B\+M\+A\+Log}

Provides easy to access and use logging features to maintain a history of activity and provide information for activity debugging. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_b_m_a_log_a66b78b476e77c269d61776386be97c65}\label{class_b_m_a_log_a66b78b476e77c269d61776386be97c65}} 
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\subsubsection{\texorpdfstring{B\+M\+A\+Log()}{BMALog()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily B\+M\+A\+Log\+::\+B\+M\+A\+Log (\begin{DoxyParamCaption}\item[{\hyperlink{class_b_m_a_console_server}{B\+M\+A\+Console\+Server} $\ast$}]{console\+Server }\end{DoxyParamCaption})}

Constructor method that accepts a pointer to the applications console server. This enables the \hyperlink{class_b_m_a_log}{B\+M\+A\+Log} object to send new log messages to the connected console sessions.


\begin{DoxyParams}{Parameters}
{\em console\+Server} & a pointer to the console server that will be used to echo log entries. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_b_m_a_log_aa85718158f606f2b0dbb7f6b7f5cc475}\label{class_b_m_a_log_aa85718158f606f2b0dbb7f6b7f5cc475}} 
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\subsubsection{\texorpdfstring{B\+M\+A\+Log()}{BMALog()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily B\+M\+A\+Log\+::\+B\+M\+A\+Log (\begin{DoxyParamCaption}\item[{\hyperlink{class_b_m_a_file}{B\+M\+A\+File} $\ast$}]{log\+File }\end{DoxyParamCaption})}

Constructor method accepts a file object that will be used to echo all log entries. This provides a permanent disk file record of all logged activity. \mbox{\Hypertarget{class_b_m_a_log_ad14bf19745d33be21431f8c0133d9ffe}\label{class_b_m_a_log_ad14bf19745d33be21431f8c0133d9ffe}} 
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\subsubsection{\texorpdfstring{B\+M\+A\+Log()}{BMALog()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily B\+M\+A\+Log\+::\+B\+M\+A\+Log (\begin{DoxyParamCaption}\item[{int}]{level }\end{DoxyParamCaption})}

Constructor method that is used to send a message to the log.


\begin{DoxyParams}{Parameters}
{\em level} & the logging level to associate with this message.\\
\hline
\end{DoxyParams}
To send log message\+: \hyperlink{class_b_m_a_log}{B\+M\+A\+Log(\+L\+O\+G\+\_\+\+I\+N\+F\+O)} $<$$<$ \char`\"{}\+This is a log message.\char`\"{}; \mbox{\Hypertarget{class_b_m_a_log_a443ae6142ef92a8ed4c9af5db57d55a0}\label{class_b_m_a_log_a443ae6142ef92a8ed4c9af5db57d55a0}} 
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!````~B\+M\+A\+Log@{$\sim$\+B\+M\+A\+Log}}
\index{````~B\+M\+A\+Log@{$\sim$\+B\+M\+A\+Log}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\subsubsection{\texorpdfstring{$\sim$\+B\+M\+A\+Log()}{~BMALog()}}
{\footnotesize\ttfamily B\+M\+A\+Log\+::$\sim$\+B\+M\+A\+Log (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

The destructor for the log object. 

\subsection{Member Data Documentation}
\mbox{\Hypertarget{class_b_m_a_log_a3d5d2e2b15c135159b42c7e1f0dcc7e1}\label{class_b_m_a_log_a3d5d2e2b15c135159b42c7e1f0dcc7e1}} 
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!console\+Server@{console\+Server}}
\index{console\+Server@{console\+Server}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\subsubsection{\texorpdfstring{console\+Server}{consoleServer}}
{\footnotesize\ttfamily \hyperlink{class_b_m_a_console_server}{B\+M\+A\+Console\+Server} $\ast$ B\+M\+A\+Log\+::console\+Server = N\+U\+LL\hspace{0.3cm}{\ttfamily [static]}}

Set the console\+Server to point to the instantiated \hyperlink{class_b_m_a_console_server}{B\+M\+A\+Console\+Server} object for the application. \mbox{\Hypertarget{class_b_m_a_log_aa5789774e19266041e1211c9c386ed21}\label{class_b_m_a_log_aa5789774e19266041e1211c9c386ed21}} 
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!log\+File@{log\+File}}
\index{log\+File@{log\+File}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\subsubsection{\texorpdfstring{log\+File}{logFile}}
{\footnotesize\ttfamily \hyperlink{class_b_m_a_file}{B\+M\+A\+File} $\ast$ B\+M\+A\+Log\+::log\+File = N\+U\+LL\hspace{0.3cm}{\ttfamily [static]}}

Specify a \hyperlink{class_b_m_a_file}{B\+M\+A\+File} object where the log entries will be written as a permanent record to disk. \mbox{\Hypertarget{class_b_m_a_log_a0d53862e6749badb4397a0fd8ce25a81}\label{class_b_m_a_log_a0d53862e6749badb4397a0fd8ce25a81}} 
\index{B\+M\+A\+Log@{B\+M\+A\+Log}!seq@{seq}}
\index{seq@{seq}!B\+M\+A\+Log@{B\+M\+A\+Log}}
\subsubsection{\texorpdfstring{seq}{seq}}
{\footnotesize\ttfamily int B\+M\+A\+Log\+::seq = 0\hspace{0.3cm}{\ttfamily [static]}}

A meaningless sequenctial number that starts from -\/ at the beginning of the logging process. 

The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
/home/barant/\+Development/\+B\+M\+A/server\+\_\+core/\+Server\+Core/B\+M\+A\+Log.\+h\item 
/home/barant/\+Development/\+B\+M\+A/server\+\_\+core/\+Server\+Core/B\+M\+A\+Log.\+cpp\end{DoxyCompactItemize}
