[140] | 1 | \section{UserInfo$<$ T $>$ Class Template Reference} |
---|
| 2 | \label{classUserInfo}\index{UserInfo@{UserInfo}} |
---|
| 3 | The main user info template class. |
---|
| 4 | |
---|
| 5 | |
---|
| 6 | {\tt \#include $<$userinfo.h$>$} |
---|
| 7 | |
---|
| 8 | Inheritance diagram for UserInfo$<$ T $>$:\nopagebreak |
---|
| 9 | \begin{figure}[H] |
---|
| 10 | \begin{center} |
---|
| 11 | \leavevmode |
---|
| 12 | \includegraphics[width=133pt]{classUserInfo__inherit__graph} |
---|
| 13 | \end{center} |
---|
| 14 | \end{figure} |
---|
| 15 | Collaboration diagram for UserInfo$<$ T $>$:\nopagebreak |
---|
| 16 | \begin{figure}[H] |
---|
| 17 | \begin{center} |
---|
| 18 | \leavevmode |
---|
| 19 | \includegraphics[width=119pt]{classUserInfo__coll__graph} |
---|
| 20 | \end{center} |
---|
| 21 | \end{figure} |
---|
| 22 | \subsection*{Public Member Functions} |
---|
| 23 | \begin{CompactItemize} |
---|
| 24 | \item |
---|
| 25 | {\bf UserInfo} (const string name, const string help\_\-msg=\char`\"{}\char`\"{})\label{classUserInfo_15450d05eb4ac5f57c03d3c0707837e1} |
---|
| 26 | |
---|
| 27 | \begin{CompactList}\small\item\em The only constructor which fills both the transcodedName and the help attribute. \item\end{CompactList}\item |
---|
| 28 | {\bf $\sim$UserInfo} ()\label{classUserInfo_7583dc01223fcd3dfb2a97d80efe4565} |
---|
| 29 | |
---|
| 30 | \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item |
---|
| 31 | virtual T $\ast$ {\bf build} (void)=0\label{classUserInfo_a7cab74e8214a87e5f226e9e88ff3d61} |
---|
| 32 | |
---|
| 33 | \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 |
---|
| 34 | void {\bf Save} (char $\ast$fileName)\label{classUserInfo_089b8a3ad514b17ae564a27328655126} |
---|
| 35 | |
---|
| 36 | \begin{CompactList}\small\item\em Save \doxyref{UserInfo}{p.}{classUserInfo} to the file (typically with an XML extension). \item\end{CompactList}\item |
---|
| 37 | void {\bf Load} (char $\ast$fileName)\label{classUserInfo_920c54d79132041a520180d083a6c503} |
---|
| 38 | |
---|
| 39 | \begin{CompactList}\small\item\em Load \doxyref{UserInfo}{p.}{classUserInfo} from the file (typically with an XML extension). \item\end{CompactList}\item |
---|
| 40 | void {\bf Attach} (MappedElements \&externalElements)\label{classUserInfo_51c1823208b719eec546b98bb855e272} |
---|
| 41 | |
---|
| 42 | \begin{CompactList}\small\item\em This method is the key method to connect the element to its parent UI element. \item\end{CompactList}\item |
---|
| 43 | void {\bf ParseElement} (DOMElement $\ast$element)\label{classUserInfo_f673ea7ee23cc87e89d1530f94817800} |
---|
| 44 | |
---|
| 45 | \begin{CompactList}\small\item\em Fills internal attributes and descendant elements according DOMElement. \item\end{CompactList}\item |
---|
| 46 | void {\bf FillElement} (DOMElement \&element)\label{classUserInfo_22ca1ef5a10740e4107cd5a7e9a72856} |
---|
| 47 | |
---|
| 48 | \begin{CompactList}\small\item\em Fills DOMElement according internal attributes and descendant elements. \item\end{CompactList}\end{CompactItemize} |
---|
| 49 | \subsection*{Public Attributes} |
---|
| 50 | \begin{CompactItemize} |
---|
| 51 | \item |
---|
| 52 | {\bf StringAttribute} {\bf help}\label{classUserInfo_b63907af7cfccefeab209f8381962092} |
---|
| 53 | |
---|
| 54 | \begin{CompactList}\small\item\em Explanation for an user is the only obligatory attribute. \item\end{CompactList}\end{CompactItemize} |
---|
| 55 | \subsection*{Protected Attributes} |
---|
| 56 | \begin{CompactItemize} |
---|
| 57 | \item |
---|
| 58 | MappedElements {\bf elements}\label{classUserInfo_20783b9cdbef32b584be96851a8f9862} |
---|
| 59 | |
---|
| 60 | \begin{CompactList}\small\item\em MappiLength of the output vector. \item\end{CompactList}\item |
---|
| 61 | {\bf Attribute::MappedAttributes} {\bf attributes}\label{classUserInfo_aa6753c220a54aba613bfa3cc115d1c8} |
---|
| 62 | |
---|
| 63 | \begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize} |
---|
| 64 | |
---|
| 65 | |
---|
| 66 | \subsection{Detailed Description} |
---|
| 67 | \subsubsection*{template$<$typename T$>$ class UserInfo$<$ T $>$} |
---|
| 68 | |
---|
| 69 | The main user info template class. |
---|
| 70 | |
---|
| 71 | You should derive this class whenever you need new \doxyref{UserInfo}{p.}{classUserInfo}. |
---|
| 72 | |
---|
| 73 | The documentation for this class was generated from the following file:\begin{CompactItemize} |
---|
| 74 | \item |
---|
[145] | 75 | work/git/mixpp/bdm/userinfo.h\end{CompactItemize} |
---|