root/doc/html/classuimatrix.html @ 145

Revision 106, 9.4 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: uimatrix&lt; T &gt; Class Template Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.5 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14      <li><a href="files.html"><span>Files</span></a></li>
15    </ul>
16  </div>
17  <div class="tabs">
18    <ul>
19      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
20      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22    </ul>
23  </div>
24</div>
25<div class="contents">
26<h1>uimatrix&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="uimatrix" --><!-- doxytag: inherits="uibase" -->User info for matrices. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="userinfo_8h-source.html">userinfo.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for uimatrix&lt; T &gt;:</div>
33<div class="dynsection">
34<p><center><img src="classuimatrix__inherit__graph.png" border="0" usemap="#uimatrix_3_01T_01_4__inherit__map" alt="Inheritance graph"></center>
35<map name="uimatrix_3_01T_01_4__inherit__map">
36<area shape="rect" href="classuibase.html" title="User Info base class." alt="" coords="25,7,84,31"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for uimatrix&lt; T &gt;:</div>
40<div class="dynsection">
41<p><center><img src="classuimatrix__coll__graph.png" border="0" usemap="#uimatrix_3_01T_01_4__coll__map" alt="Collaboration graph"></center>
42<map name="uimatrix_3_01T_01_4__coll__map">
43<area shape="rect" href="classuibase.html" title="User Info base class." alt="" coords="25,111,84,135"></map>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classuimatrix-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
48<tr><td></td></tr>
49<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5817e2696f293a751b6690792f3e7aa8"></a><!-- doxytag: member="uimatrix::uimatrix" ref="5817e2696f293a751b6690792f3e7aa8" args="(std::string com, uibase *par=NULL)" -->
51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuimatrix.html#5817e2696f293a751b6690792f3e7aa8">uimatrix</a> (std::string com, <a class="el" href="classuibase.html">uibase</a> *par=NULL)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72da139481128a8fc979cb38b031504c"></a><!-- doxytag: member="uimatrix::getsummary" ref="72da139481128a8fc979cb38b031504c" args="(std::string &amp;S)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuimatrix.html#72da139481128a8fc979cb38b031504c">getsummary</a> (std::string &amp;S)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a summary of its contents (used in dialogs) <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b1649ae99267ee98164d4a3d3e3fb05"></a><!-- doxytag: member="uimatrix::askuser" ref="4b1649ae99267ee98164d4a3d3e3fb05" args="()" -->
59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuimatrix.html#4b1649ae99267ee98164d4a3d3e3fb05">askuser</a> ()</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">interaction with the user <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8176b9d61acfe32cad75eca372190eb8"></a><!-- doxytag: member="uimatrix::save" ref="8176b9d61acfe32cad75eca372190eb8" args="(std::ostream &amp;os)" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuimatrix.html#8176b9d61acfe32cad75eca372190eb8">save</a> (std::ostream &amp;os)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save to file. <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="664307ac6fc483e506b831d80a60b7a8"></a><!-- doxytag: member="uimatrix::load" ref="664307ac6fc483e506b831d80a60b7a8" args="(std::istream &amp;is)" -->
67void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuimatrix.html#664307ac6fc483e506b831d80a60b7a8">load</a> (std::istream &amp;is)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">load from file <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc00f8af1706d634b11458c49a52a7b3"></a><!-- doxytag: member="uimatrix::set_value" ref="cc00f8af1706d634b11458c49a52a7b3" args="(itpp::Mat&lt; T &gt; M0)" -->
71void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuimatrix.html#cc00f8af1706d634b11458c49a52a7b3">set_value</a> (itpp::Mat&lt; T &gt; M0)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7403110752e92a31db563556124742e"></a><!-- doxytag: member="uimatrix::isvalid" ref="e7403110752e92a31db563556124742e" args="()" -->
75virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#e7403110752e92a31db563556124742e">isvalid</a> ()</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">test if the info is valid <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e05d51c68e5e690110208ebad4c0a037"></a><!-- doxytag: member="uimatrix::get_level" ref="e05d51c68e5e690110208ebad4c0a037" args="()" -->
79int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#e05d51c68e5e690110208ebad4c0a037">get_level</a> ()</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
82<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd0ae0b8efd7cda2fb043d9a2d67b9e9"></a><!-- doxytag: member="uimatrix::M" ref="fd0ae0b8efd7cda2fb043d9a2d67b9e9" args="" -->
84itpp::Mat&lt; T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuimatrix.html#fd0ae0b8efd7cda2fb043d9a2d67b9e9">M</a></td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Value. <br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b093af7c0a2a8b9bc3e71c1dc83779c3"></a><!-- doxytag: member="uimatrix::name" ref="b093af7c0a2a8b9bc3e71c1dc83779c3" args="" -->
88string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#b093af7c0a2a8b9bc3e71c1dc83779c3">name</a></td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">String identifier of a field. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4bf69e2353bf0620e0dd714e0d92473a"></a><!-- doxytag: member="uimatrix::help" ref="4bf69e2353bf0620e0dd714e0d92473a" args="" -->
92string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#4bf69e2353bf0620e0dd714e0d92473a">help</a></td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Explanation for a user what the field means. <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b6ae5af990c9edfa34fe9e1ea95afe7"></a><!-- doxytag: member="uimatrix::parent" ref="0b6ae5af990c9edfa34fe9e1ea95afe7" args="" -->
96<a class="el" href="classuibase.html">uibase</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#0b6ae5af990c9edfa34fe9e1ea95afe7">parent</a></td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Possible parent of the userinfo. <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d903be35ad6f3932eb5d8df8777e0fa1"></a><!-- doxytag: member="uimatrix::ilevel" ref="d903be35ad6f3932eb5d8df8777e0fa1" args="" -->
100int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#d903be35ad6f3932eb5d8df8777e0fa1">ilevel</a></td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentation level, i.e. number of parents. <br></td></tr>
103</table>
104<hr><a name="_details"></a><h2>Detailed Description</h2>
105<h3>template&lt;class T&gt;<br>
106 class uimatrix&lt; T &gt;</h3>
107
108User info for matrices. <hr>The documentation for this class was generated from the following file:<ul>
109<li>work/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul>
110</div>
111<hr size="1"><address style="text-align: right;"><small>Generated on Fri May 9 23:06:44 2008 for mixpp by&nbsp;
112<a href="http://www.doxygen.org/index.html">
113<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
114</body>
115</html>
Note: See TracBrowser for help on using the browser.