root/doc/latex/classuiscalar.tex @ 180

\section{uiscalar$<$ T $>$ Class Template Reference}
\label{classuiscalar}\index{uiscalar@{uiscalar}}
User info for scalars.  


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

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

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

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

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

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

\begin{CompactList}\small\item\em load from file \item\end{CompactList}\item 
{\bf $\sim$uiscalar} ()\label{classuiscalar_23b474d26466a4b11f3adfd515da5ed1}

\begin{CompactList}\small\item\em for future use \item\end{CompactList}\item 
void {\bf set\_\-value} (T N0)\label{classuiscalar_3db4fc9c4970f184d4e78c492842a2d2}

\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 
T {\bf N}\label{classuiscalar_42d6a9f5bc37168a76e735d1254b97b8}

\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 uiscalar$<$ T $>$}

User info for scalars. 

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