[99] | 1 | \section{uimatrix$<$ T $>$ Class Template Reference} |
---|
| 2 | \label{classuimatrix}\index{uimatrix@{uimatrix}} |
---|
| 3 | User info for matrices. |
---|
| 4 | |
---|
| 5 | |
---|
| 6 | {\tt \#include $<$userinfo.h$>$} |
---|
| 7 | |
---|
| 8 | Inheritance diagram for uimatrix$<$ T $>$:\nopagebreak |
---|
| 9 | \begin{figure}[H] |
---|
| 10 | \begin{center} |
---|
| 11 | \leavevmode |
---|
| 12 | \includegraphics[width=59pt]{classuimatrix__inherit__graph} |
---|
| 13 | \end{center} |
---|
| 14 | \end{figure} |
---|
| 15 | Collaboration diagram for uimatrix$<$ T $>$:\nopagebreak |
---|
| 16 | \begin{figure}[H] |
---|
| 17 | \begin{center} |
---|
| 18 | \leavevmode |
---|
| 19 | \includegraphics[width=74pt]{classuimatrix__coll__graph} |
---|
| 20 | \end{center} |
---|
| 21 | \end{figure} |
---|
| 22 | \subsection*{Public Member Functions} |
---|
| 23 | \begin{CompactItemize} |
---|
| 24 | \item |
---|
| 25 | {\bf uimatrix} (std::string com, {\bf uibase} $\ast$par=NULL)\label{classuimatrix_5817e2696f293a751b6690792f3e7aa8} |
---|
| 26 | |
---|
| 27 | \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item |
---|
| 28 | void {\bf getsummary} (std::string \&S)\label{classuimatrix_72da139481128a8fc979cb38b031504c} |
---|
| 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{classuimatrix_4b1649ae99267ee98164d4a3d3e3fb05} |
---|
| 32 | |
---|
| 33 | \begin{CompactList}\small\item\em interaction with the user \item\end{CompactList}\item |
---|
| 34 | void {\bf save} (std::ostream \&os)\label{classuimatrix_8176b9d61acfe32cad75eca372190eb8} |
---|
| 35 | |
---|
| 36 | \begin{CompactList}\small\item\em Save to file. \item\end{CompactList}\item |
---|
| 37 | void {\bf load} (std::istream \&is)\label{classuimatrix_664307ac6fc483e506b831d80a60b7a8} |
---|
| 38 | |
---|
| 39 | \begin{CompactList}\small\item\em load from file \item\end{CompactList}\item |
---|
| 40 | void {\bf set\_\-value} (itpp::Mat$<$ T $>$ M0)\label{classuimatrix_cc00f8af1706d634b11458c49a52a7b3} |
---|
| 41 | |
---|
| 42 | \begin{CompactList}\small\item\em access function \item\end{CompactList}\item |
---|
| 43 | virtual bool {\bf isvalid} ()\label{classuibase_e7403110752e92a31db563556124742e} |
---|
| 44 | |
---|
| 45 | \begin{CompactList}\small\item\em test if the info is valid \item\end{CompactList}\item |
---|
| 46 | int {\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 |
---|
| 52 | itpp::Mat$<$ T $>$ {\bf M}\label{classuimatrix_fd0ae0b8efd7cda2fb043d9a2d67b9e9} |
---|
| 53 | |
---|
| 54 | \begin{CompactList}\small\item\em Value. \item\end{CompactList}\item |
---|
| 55 | string {\bf name}\label{classuibase_b093af7c0a2a8b9bc3e71c1dc83779c3} |
---|
| 56 | |
---|
| 57 | \begin{CompactList}\small\item\em String identifier of a field. \item\end{CompactList}\item |
---|
| 58 | string {\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 |
---|
| 64 | int {\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 uimatrix$<$ T $>$} |
---|
| 71 | |
---|
| 72 | User info for matrices. |
---|
| 73 | |
---|
| 74 | The documentation for this class was generated from the following file:\begin{CompactItemize} |
---|
| 75 | \item |
---|
| 76 | work/mixpp/bdm/userinfo.h\end{CompactItemize} |
---|