1 | \section{uiscalar$<$ T $>$ Class Template Reference} |
---|
2 | \label{classuiscalar}\index{uiscalar@{uiscalar}} |
---|
3 | User info for scalars. |
---|
4 | |
---|
5 | |
---|
6 | {\tt \#include $<$userinfo.h$>$} |
---|
7 | |
---|
8 | Inheritance diagram for uiscalar$<$ T $>$:\nopagebreak |
---|
9 | \begin{figure}[H] |
---|
10 | \begin{center} |
---|
11 | \leavevmode |
---|
12 | \includegraphics[width=59pt]{classuiscalar__inherit__graph} |
---|
13 | \end{center} |
---|
14 | \end{figure} |
---|
15 | Collaboration diagram for uiscalar$<$ T $>$:\nopagebreak |
---|
16 | \begin{figure}[H] |
---|
17 | \begin{center} |
---|
18 | \leavevmode |
---|
19 | \includegraphics[width=89pt]{classuiscalar__coll__graph} |
---|
20 | \end{center} |
---|
21 | \end{figure} |
---|
22 | \subsection*{Public Member Functions} |
---|
23 | \begin{CompactItemize} |
---|
24 | \item |
---|
25 | {\bf uiscalar} (std::string com, {\bf uibase} $\ast$par=NULL)\label{classuiscalar_4b71f9d9246a3715df44d9701b1cbfdd} |
---|
26 | |
---|
27 | \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item |
---|
28 | void {\bf getsummary} (std::string \&S)\label{classuiscalar_cc3639d49c2577e7c40ebaf48ced444f} |
---|
29 | |
---|
30 | \begin{CompactList}\small\item\em returns a summary of its contents (used in dialogs) \item\end{CompactList}\item |
---|
31 | void {\bf askuser} ()\label{classuiscalar_9a21e792b929d081c33321714fbfe94f} |
---|
32 | |
---|
33 | \begin{CompactList}\small\item\em interaction with the user \item\end{CompactList}\item |
---|
34 | void {\bf save} (std::ostream \&os)\label{classuiscalar_ccb9739e4989d7489dca75ea673238dd} |
---|
35 | |
---|
36 | \begin{CompactList}\small\item\em Save to file. \item\end{CompactList}\item |
---|
37 | void {\bf load} (std::istream \&is)\label{classuiscalar_135480b7762b221331076227c292869c} |
---|
38 | |
---|
39 | \begin{CompactList}\small\item\em load from file \item\end{CompactList}\item |
---|
40 | {\bf $\sim$uiscalar} ()\label{classuiscalar_23b474d26466a4b11f3adfd515da5ed1} |
---|
41 | |
---|
42 | \begin{CompactList}\small\item\em for future use \item\end{CompactList}\item |
---|
43 | void {\bf set\_\-value} (T N0)\label{classuiscalar_3db4fc9c4970f184d4e78c492842a2d2} |
---|
44 | |
---|
45 | \begin{CompactList}\small\item\em access function \item\end{CompactList}\item |
---|
46 | virtual bool {\bf isvalid} ()\label{classuibase_e7403110752e92a31db563556124742e} |
---|
47 | |
---|
48 | \begin{CompactList}\small\item\em test if the info is valid \item\end{CompactList}\item |
---|
49 | int {\bf get\_\-level} ()\label{classuibase_e05d51c68e5e690110208ebad4c0a037} |
---|
50 | |
---|
51 | \begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize} |
---|
52 | \subsection*{Protected Attributes} |
---|
53 | \begin{CompactItemize} |
---|
54 | \item |
---|
55 | T {\bf N}\label{classuiscalar_42d6a9f5bc37168a76e735d1254b97b8} |
---|
56 | |
---|
57 | \begin{CompactList}\small\item\em Value. \item\end{CompactList}\item |
---|
58 | string {\bf name}\label{classuibase_b093af7c0a2a8b9bc3e71c1dc83779c3} |
---|
59 | |
---|
60 | \begin{CompactList}\small\item\em String identifier of a field. \item\end{CompactList}\item |
---|
61 | string {\bf help}\label{classuibase_4bf69e2353bf0620e0dd714e0d92473a} |
---|
62 | |
---|
63 | \begin{CompactList}\small\item\em Explanation for a user what the field means. \item\end{CompactList}\item |
---|
64 | {\bf uibase} $\ast$ {\bf parent}\label{classuibase_0b6ae5af990c9edfa34fe9e1ea95afe7} |
---|
65 | |
---|
66 | \begin{CompactList}\small\item\em Possible parent of the userinfo. \item\end{CompactList}\item |
---|
67 | int {\bf ilevel}\label{classuibase_d903be35ad6f3932eb5d8df8777e0fa1} |
---|
68 | |
---|
69 | \begin{CompactList}\small\item\em Indentation level, i.e. number of parents. \item\end{CompactList}\end{CompactItemize} |
---|
70 | |
---|
71 | |
---|
72 | \subsection{Detailed Description} |
---|
73 | \subsubsection*{template$<$class T$>$ class uiscalar$<$ T $>$} |
---|
74 | |
---|
75 | User info for scalars. |
---|
76 | |
---|
77 | The documentation for this class was generated from the following file:\begin{CompactItemize} |
---|
78 | \item |
---|
79 | work/mixpp/bdm/userinfo.h\end{CompactItemize} |
---|