root/doc/latex/classuimatrix.tex @ 255

\section{uimatrix$<$ T $>$ Class Template Reference}
\label{classuimatrix}\index{uimatrix@{uimatrix}}
User info for matrices.  


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

Inheritance diagram for uimatrix$<$ T $>$:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=59pt]{classuimatrix__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for uimatrix$<$ T $>$:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=74pt]{classuimatrix__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf uimatrix} (std::string com, {\bf uibase} $\ast$par=NULL)\label{classuimatrix_5817e2696f293a751b6690792f3e7aa8}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
void {\bf getsummary} (std::string \&S)\label{classuimatrix_72da139481128a8fc979cb38b031504c}

\begin{CompactList}\small\item\em returns a summary of its contents (used in dialogs) \item\end{CompactList}\item 
void {\bf askuser} ()\label{classuimatrix_4b1649ae99267ee98164d4a3d3e3fb05}

\begin{CompactList}\small\item\em interaction with the user \item\end{CompactList}\item 
void {\bf save} (std::ostream \&os)\label{classuimatrix_8176b9d61acfe32cad75eca372190eb8}

\begin{CompactList}\small\item\em Save to file. \item\end{CompactList}\item 
void {\bf load} (std::istream \&is)\label{classuimatrix_664307ac6fc483e506b831d80a60b7a8}

\begin{CompactList}\small\item\em load from file \item\end{CompactList}\item 
void {\bf set\_\-value} (itpp::Mat$<$ T $>$ M0)\label{classuimatrix_cc00f8af1706d634b11458c49a52a7b3}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
virtual bool {\bf isvalid} ()\label{classuibase_e7403110752e92a31db563556124742e}

\begin{CompactList}\small\item\em test if the info is valid \item\end{CompactList}\item 
int {\bf get\_\-level} ()\label{classuibase_e05d51c68e5e690110208ebad4c0a037}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
itpp::Mat$<$ T $>$ {\bf M}\label{classuimatrix_fd0ae0b8efd7cda2fb043d9a2d67b9e9}

\begin{CompactList}\small\item\em Value. \item\end{CompactList}\item 
string {\bf name}\label{classuibase_b093af7c0a2a8b9bc3e71c1dc83779c3}

\begin{CompactList}\small\item\em String identifier of a field. \item\end{CompactList}\item 
string {\bf help}\label{classuibase_4bf69e2353bf0620e0dd714e0d92473a}

\begin{CompactList}\small\item\em Explanation for a user what the field means. \item\end{CompactList}\item 
{\bf uibase} $\ast$ {\bf parent}\label{classuibase_0b6ae5af990c9edfa34fe9e1ea95afe7}

\begin{CompactList}\small\item\em Possible parent of the userinfo. \item\end{CompactList}\item 
int {\bf ilevel}\label{classuibase_d903be35ad6f3932eb5d8df8777e0fa1}

\begin{CompactList}\small\item\em Indentation level, i.e. number of parents. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$class T$>$ class uimatrix$<$ T $>$}

User info for matrices. 

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