root/doc/latex/classuivector.tex @ 234

Revision 99, 3.2 kB (checked in by smidl, 16 years ago)

doc

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