root/doc/latex/classUIrv.tex @ 275

\hypertarget{classUIrv}{
\section{UIrv Class Reference}
\label{classUIrv}\index{UIrv@{UIrv}}
}
{\tt \#include $<$loggers\_\-ui.h$>$}

Inheritance diagram for UIrv::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classUIrv}
\end{center}
\end{figure}


\subsection{Detailed Description}
UI for class RV (description of data vectors). 



\begin{Code}\begin{verbatim}rv = {
        type = "rv"; //identifier of the description
        // UNIQUE IDENTIFIER same names = same variable
        names = ["a", "b", "c", ...];   // which will be used e.g. in loggers 

        //optional arguments
        sizes = [1, 2, 3, ...];         // (optional) default = ones()
        times = [-1, -2, 0, ...];       // time shifts with respect to current time (optional) default = zeros()
}
\end{verbatim}
\end{Code}

 \subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classUIrv_c7c4a2d75a7ce775b59efeed8fc928dc}{
\hyperlink{classbdm_1_1bdmroot}{bdmroot} $\ast$ \hyperlink{classUIrv_c7c4a2d75a7ce775b59efeed8fc928dc}{build} (Setting \&S) const }
\label{classUIrv_c7c4a2d75a7ce775b59efeed8fc928dc}

\begin{CompactList}\small\item\em Function building the computational object. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}{
const vec \textbf{getvec} (Setting \&S) const }
\label{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}

\item 
\hypertarget{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}{
const mat \textbf{getmat} (Setting \&S, int ncols) const }
\label{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}

\item 
\hypertarget{classbdm_1_1UIbuilder_950437aed29283d10346f4966011a64e}{
const ivec \textbf{getivec} (Setting \&S) const }
\label{classbdm_1_1UIbuilder_950437aed29283d10346f4966011a64e}

\item 
\hypertarget{classbdm_1_1UIbuilder_4ea1d97d81aba46dfe0e7fd416a4ad22}{
const Array$<$ string $>$ \textbf{get\_\-as} (Setting \&S) const }
\label{classbdm_1_1UIbuilder_4ea1d97d81aba46dfe0e7fd416a4ad22}

\end{CompactItemize}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
\hyperlink{loggers__ui_8h}{loggers\_\-ui.h}\end{CompactItemize}