root/doc/latex/classbdm_1_1logger.tex @ 271

\hypertarget{classbdm_1_1logger}{
\section{bdm::logger Class Reference}
\label{classbdm_1_1logger}\index{bdm::logger@{bdm::logger}}
}
{\tt \#include $<$libBM.h$>$}

Inheritance diagram for bdm::logger::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classbdm_1_1logger}
\end{center}
\end{figure}


\subsection{Detailed Description}
Class for storing results (and semi-results) of an experiment. 

This class abstracts logging of results from implementation. This class replaces direct logging of results (e.g. to files or to global variables) by calling methods of a \hyperlink{classbdm_1_1logger}{logger}. Specializations of this abstract class for specific storage method are designed. \subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1logger_f9c2fe7db5ddbda0098a4a5bd2c29fbf}{
\hyperlink{classbdm_1_1logger_f9c2fe7db5ddbda0098a4a5bd2c29fbf}{logger} ()}
\label{classbdm_1_1logger_f9c2fe7db5ddbda0098a4a5bd2c29fbf}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual int \hyperlink{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{add} (const \hyperlink{classbdm_1_1RV}{RV} \&rv, string name=\char`\"{}\char`\"{})
\item 
\hypertarget{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}{
virtual void \hyperlink{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}{logit} (int id, const vec \&v)=0}
\label{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}

\begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item 
\hypertarget{classbdm_1_1logger_4f31c03578a7b9b30d8b1f8c338a37e8}{
virtual void \hyperlink{classbdm_1_1logger_4f31c03578a7b9b30d8b1f8c338a37e8}{step} ()=0}
\label{classbdm_1_1logger_4f31c03578a7b9b30d8b1f8c338a37e8}

\begin{CompactList}\small\item\em Shifts storage position for another time step. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}{
virtual void \hyperlink{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}{finalize} ()}
\label{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}

\begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1logger_cd6291a73491f755dc7bc88d022eb2fc}{
virtual void \hyperlink{classbdm_1_1logger_cd6291a73491f755dc7bc88d022eb2fc}{init} ()}
\label{classbdm_1_1logger_cd6291a73491f755dc7bc88d022eb2fc}

\begin{CompactList}\small\item\em Initialize the storage. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{
Array$<$ \hyperlink{classbdm_1_1RV}{RV} $>$ \hyperlink{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{entries}}
\label{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}

\begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{
Array$<$ string $>$ \hyperlink{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{names}}
\label{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}

\begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize}


\subsection{Member Function Documentation}
\hypertarget{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{
\index{bdm::logger@{bdm::logger}!add@{add}}
\index{add@{add}!bdm::logger@{bdm::logger}}
\subsubsection[add]{\setlength{\rightskip}{0pt plus 5cm}virtual int bdm::logger::add (const {\bf RV} \& {\em rv}, \/  string {\em name} = {\tt \char`\"{}\char`\"{}})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
\label{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}


returns an identifier which will be later needed for calling the {\tt \hyperlink{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}{logit()}} function For empty \hyperlink{classbdm_1_1RV}{RV} it returns -1, this entry will be ignored by {\tt \hyperlink{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}{logit()}}. 

References entries, and names.

Referenced by bdm::ArxDS::log\_\-add(), and bdm::DS::log\_\-add().

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}