root/doc/latex/classUserInfo.tex @ 142

\section{UserInfo$<$ T $>$ Class Template Reference}
\label{classUserInfo}\index{UserInfo@{UserInfo}}
The main user info template class.  


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

Inheritance diagram for UserInfo$<$ T $>$:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=133pt]{classUserInfo__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for UserInfo$<$ T $>$:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=119pt]{classUserInfo__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf UserInfo} (const string name, const string help\_\-msg=\char`\"{}\char`\"{})\label{classUserInfo_15450d05eb4ac5f57c03d3c0707837e1}

\begin{CompactList}\small\item\em The only constructor which fills both the transcodedName and the help attribute. \item\end{CompactList}\item 
{\bf $\sim$UserInfo} ()\label{classUserInfo_7583dc01223fcd3dfb2a97d80efe4565}

\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
virtual T $\ast$ {\bf build} (void)=0\label{classUserInfo_a7cab74e8214a87e5f226e9e88ff3d61}

\begin{CompactList}\small\item\em returns object of templated type filled with data stored in this \doxyref{UserInfo}{p.}{classUserInfo} instance \item\end{CompactList}\item 
void {\bf Save} (char $\ast$fileName)\label{classUserInfo_089b8a3ad514b17ae564a27328655126}

\begin{CompactList}\small\item\em Save \doxyref{UserInfo}{p.}{classUserInfo} to the file (typically with an XML extension). \item\end{CompactList}\item 
void {\bf Load} (char $\ast$fileName)\label{classUserInfo_920c54d79132041a520180d083a6c503}

\begin{CompactList}\small\item\em Load \doxyref{UserInfo}{p.}{classUserInfo} from the file (typically with an XML extension). \item\end{CompactList}\item 
void {\bf Attach} (MappedElements \&externalElements)\label{classUserInfo_51c1823208b719eec546b98bb855e272}

\begin{CompactList}\small\item\em This method is the key method to connect the element to its parent UI element. \item\end{CompactList}\item 
void {\bf ParseElement} (DOMElement $\ast$element)\label{classUserInfo_f673ea7ee23cc87e89d1530f94817800}

\begin{CompactList}\small\item\em Fills internal attributes and descendant elements according DOMElement. \item\end{CompactList}\item 
void {\bf FillElement} (DOMElement \&element)\label{classUserInfo_22ca1ef5a10740e4107cd5a7e9a72856}

\begin{CompactList}\small\item\em Fills DOMElement according internal attributes and descendant elements. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
{\bf StringAttribute} {\bf help}\label{classUserInfo_b63907af7cfccefeab209f8381962092}

\begin{CompactList}\small\item\em Explanation for an user is the only obligatory attribute. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
MappedElements {\bf elements}\label{classUserInfo_20783b9cdbef32b584be96851a8f9862}

\begin{CompactList}\small\item\em MappiLength of the output vector. \item\end{CompactList}\item 
{\bf Attribute::MappedAttributes} {\bf attributes}\label{classUserInfo_aa6753c220a54aba613bfa3cc115d1c8}

\begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize}


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

The main user info template class. 

You should derive this class whenever you need new \doxyref{UserInfo}{p.}{classUserInfo}. 

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