root/doc/html/classuibase.html @ 131

Revision 106, 9.0 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: uibase Class 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>uibase Class Reference</h1><!-- doxytag: class="uibase" -->User Info base class. 
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 uibase:</div>
33<div class="dynsection">
34<p><center><img src="classuibase__inherit__graph.png" border="0" usemap="#uibase__inherit__map" alt="Inheritance graph"></center>
35<map name="uibase__inherit__map">
36<area shape="rect" href="classuimatrix.html" title="User info for matrices." alt="" coords="5,81,104,105"><area shape="rect" href="classuiscalar.html" title="User info for scalars." alt="" coords="219,81,317,105"><area shape="rect" href="classuistring.html" title="User info for strings." alt="" coords="341,81,405,105"><area shape="rect" href="classuivector.html" title="User info for vectors." alt="" coords="429,81,528,105"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for uibase:</div>
40<div class="dynsection">
41<p><center><img src="classuibase__coll__graph.png" border="0" usemap="#uibase__coll__map" alt="Collaboration graph"></center>
42<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
43
44<p>
45<a href="classuibase-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
46<tr><td></td></tr>
47<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2f0551822ed7af25f8e7ffbe7c0a8f97"></a><!-- doxytag: member="uibase::uibase" ref="2f0551822ed7af25f8e7ffbe7c0a8f97" args="(string com=&quot;Abstract class, please ignore!&quot;, uibase *par=NULL)" -->
49&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#2f0551822ed7af25f8e7ffbe7c0a8f97">uibase</a> (string com=&quot;Abstract class, please ignore!&quot;, uibase *par=NULL)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de805f1ce9c1b261dc47d57c506d36f1"></a><!-- doxytag: member="uibase::getsummary" ref="de805f1ce9c1b261dc47d57c506d36f1" args="(std::string &amp;S)" -->
53virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#de805f1ce9c1b261dc47d57c506d36f1">getsummary</a> (std::string &amp;S)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a summary of its contents (used in dialogs) <br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d28232d94715c153afb9280a8a4552eb"></a><!-- doxytag: member="uibase::askuser" ref="d28232d94715c153afb9280a8a4552eb" args="()" -->
57virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#d28232d94715c153afb9280a8a4552eb">askuser</a> ()</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">interaction with the user <br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7403110752e92a31db563556124742e"></a><!-- doxytag: member="uibase::isvalid" ref="e7403110752e92a31db563556124742e" args="()" -->
61virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#e7403110752e92a31db563556124742e">isvalid</a> ()</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">test if the info is valid <br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1972e8d075e083e0f033ac2e4fee3a7a"></a><!-- doxytag: member="uibase::~uibase" ref="1972e8d075e083e0f033ac2e4fee3a7a" args="()" -->
65virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#1972e8d075e083e0f033ac2e4fee3a7a">~uibase</a> ()</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">for future use <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6986cef72dc78d8caaddf05481dc9eb2"></a><!-- doxytag: member="uibase::save" ref="6986cef72dc78d8caaddf05481dc9eb2" args="(std::ostream &amp;os)" -->
69virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#6986cef72dc78d8caaddf05481dc9eb2">save</a> (std::ostream &amp;os)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save to file. <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb22da8503624c0d52d84817b00acba3"></a><!-- doxytag: member="uibase::load" ref="eb22da8503624c0d52d84817b00acba3" args="(std::istream &amp;is)" -->
73virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#eb22da8503624c0d52d84817b00acba3">load</a> (std::istream &amp;is)</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">load from file <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e05d51c68e5e690110208ebad4c0a037"></a><!-- doxytag: member="uibase::get_level" ref="e05d51c68e5e690110208ebad4c0a037" args="()" -->
77int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#e05d51c68e5e690110208ebad4c0a037">get_level</a> ()</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
80<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b093af7c0a2a8b9bc3e71c1dc83779c3"></a><!-- doxytag: member="uibase::name" ref="b093af7c0a2a8b9bc3e71c1dc83779c3" args="" -->
82string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#b093af7c0a2a8b9bc3e71c1dc83779c3">name</a></td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">String identifier of a field. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4bf69e2353bf0620e0dd714e0d92473a"></a><!-- doxytag: member="uibase::help" ref="4bf69e2353bf0620e0dd714e0d92473a" args="" -->
86string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#4bf69e2353bf0620e0dd714e0d92473a">help</a></td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Explanation for a user what the field means. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b6ae5af990c9edfa34fe9e1ea95afe7"></a><!-- doxytag: member="uibase::parent" ref="0b6ae5af990c9edfa34fe9e1ea95afe7" args="" -->
90<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>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Possible parent of the userinfo. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d903be35ad6f3932eb5d8df8777e0fa1"></a><!-- doxytag: member="uibase::ilevel" ref="d903be35ad6f3932eb5d8df8777e0fa1" args="" -->
94int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#d903be35ad6f3932eb5d8df8777e0fa1">ilevel</a></td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentation level, i.e. number of parents. <br></td></tr>
97</table>
98<hr><a name="_details"></a><h2>Detailed Description</h2>
99User Info base class.
100<p>
101This class is used to store information about parameters of an object. It support loading and saving of the information and, potentially, interaction with the user. <hr>The documentation for this class was generated from the following file:<ul>
102<li>work/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul>
103</div>
104<hr size="1"><address style="text-align: right;"><small>Generated on Fri May 9 23:06:44 2008 for mixpp by&nbsp;
105<a href="http://www.doxygen.org/index.html">
106<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
107</body>
108</html>
Note: See TracBrowser for help on using the browser.