root/doc/latex/classlogger.tex @ 162

\section{logger Class Reference}
\label{classlogger}\index{logger@{logger}}
Class for storing results (and semi-results) of an experiment.  


{\tt \#include $<$loggers.h$>$}

Inheritance diagram for logger:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=48pt]{classlogger__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf logger} ()\label{classlogger_4f753a510e00c892b38e95c2284363a6}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual int {\bf add} (const {\bf RV} \&rv, string name=\char`\"{}\char`\"{})\label{classlogger_cfb250a559b71e07a1a6aa92f2185c1b}

\begin{CompactList}\small\item\em returns an identifier which will be later needed for calling the log() function \item\end{CompactList}\item 
virtual void {\bf logit} (int id, vec v)=0\label{classlogger_efb5a59cb329f58810b09bd9cc270b78}

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

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

\begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\item 
virtual {\bf $\sim$logger} ()\label{classlogger_92c63a0a87392c62b9ed3c00faa9d5df}

\begin{CompactList}\small\item\em for future use \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
Array$<$ {\bf RV} $>$ {\bf entries}\label{classlogger_83eea0cf4fbca59474d015f751f128a7}

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

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


\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 \doxyref{logger}{p.}{classlogger}. Specializations of this abstract class for specific storage method are designed. 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
work/git/mixpp/bdm/stat/{\bf loggers.h}\end{CompactItemize}