root/doc/html/classUserInfo.html @ 145

Revision 145, 10.3 kB (checked in by smidl, 16 years ago)

Oprava dokumentace

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: UserInfo&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.6 -->
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>UserInfo&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="UserInfo" --><!-- doxytag: inherits="UserInfoCore" -->The main user info template 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 UserInfo&lt; T &gt;:</div>
33<div class="dynsection">
34<p><center><img src="classUserInfo__inherit__graph.png" border="0" usemap="#UserInfo_3_01T_01_4__inherit__map" alt="Inheritance graph"></center>
35<map name="UserInfo_3_01T_01_4__inherit__map">
36<area shape="rect" href="classUserInfo.html" title="UserInfo\&lt; Car \&gt;" alt="" coords="5,183,131,209"><area shape="rect" href="classUserInfo.html" title="UserInfo\&lt; Engine \&gt;" alt="" coords="155,183,301,209"><area shape="rect" href="classUserInfoCore.html" title="UserInfoCore class is for internal purposes only. Use UserInfo&lt;T&gt; instead." alt="" coords="76,7,180,33"><area shape="rect" href="classCarUI.html" title="User info for strings." alt="" coords="40,263,96,289"><area shape="rect" href="classEngineUI.html" title="User info for strings." alt="" coords="189,263,267,289"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for UserInfo&lt; T &gt;:</div>
40<div class="dynsection">
41<p><center><img src="classUserInfo__coll__graph.png" border="0" usemap="#UserInfo_3_01T_01_4__coll__map" alt="Collaboration graph"></center>
42<map name="UserInfo_3_01T_01_4__coll__map">
43<area shape="rect" href="classUserInfoCore.html" title="UserInfoCore class is for internal purposes only. Use UserInfo&lt;T&gt; instead." alt="" coords="5,103,109,129"><area shape="rect" href="classStringAttribute.html" title="Class encapsulating all the necessary stuff to work with a string attribute." alt="" coords="133,103,248,129"><area shape="rect" href="classAttribute.html" title="User Info base class." alt="" coords="107,7,184,33"></map>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classUserInfo-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="15450d05eb4ac5f57c03d3c0707837e1"></a><!-- doxytag: member="UserInfo::UserInfo" ref="15450d05eb4ac5f57c03d3c0707837e1" args="(const string name, const string help_msg=&quot;&quot;)" -->
51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#15450d05eb4ac5f57c03d3c0707837e1">UserInfo</a> (const string name, const string help_msg=&quot;&quot;)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The only constructor which fills both the transcodedName and the help attribute. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7583dc01223fcd3dfb2a97d80efe4565"></a><!-- doxytag: member="UserInfo::~UserInfo" ref="7583dc01223fcd3dfb2a97d80efe4565" args="()" -->
55&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#7583dc01223fcd3dfb2a97d80efe4565">~UserInfo</a> ()</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7cab74e8214a87e5f226e9e88ff3d61"></a><!-- doxytag: member="UserInfo::build" ref="a7cab74e8214a87e5f226e9e88ff3d61" args="(void)=0" -->
59virtual T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#a7cab74e8214a87e5f226e9e88ff3d61">build</a> (void)=0</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns object of templated type filled with data stored in this <a class="el" href="classUserInfo.html" title="The main user info template class.">UserInfo</a> instance <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="089b8a3ad514b17ae564a27328655126"></a><!-- doxytag: member="UserInfo::Save" ref="089b8a3ad514b17ae564a27328655126" args="(char *fileName)" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#089b8a3ad514b17ae564a27328655126">Save</a> (char *fileName)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save <a class="el" href="classUserInfo.html" title="The main user info template class.">UserInfo</a> to the file (typically with an XML extension). <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="920c54d79132041a520180d083a6c503"></a><!-- doxytag: member="UserInfo::Load" ref="920c54d79132041a520180d083a6c503" args="(char *fileName)" -->
67void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#920c54d79132041a520180d083a6c503">Load</a> (char *fileName)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load <a class="el" href="classUserInfo.html" title="The main user info template class.">UserInfo</a> from the file (typically with an XML extension). <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51c1823208b719eec546b98bb855e272"></a><!-- doxytag: member="UserInfo::Attach" ref="51c1823208b719eec546b98bb855e272" args="(MappedElements &amp;externalElements)" -->
71void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#51c1823208b719eec546b98bb855e272">Attach</a> (MappedElements &amp;externalElements)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is the key method to connect the element to its parent UI element. <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f673ea7ee23cc87e89d1530f94817800"></a><!-- doxytag: member="UserInfo::ParseElement" ref="f673ea7ee23cc87e89d1530f94817800" args="(DOMElement *element)" -->
75void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#f673ea7ee23cc87e89d1530f94817800">ParseElement</a> (DOMElement *element)</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fills internal attributes and descendant elements according DOMElement. <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22ca1ef5a10740e4107cd5a7e9a72856"></a><!-- doxytag: member="UserInfo::FillElement" ref="22ca1ef5a10740e4107cd5a7e9a72856" args="(DOMElement &amp;element)" -->
79void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#22ca1ef5a10740e4107cd5a7e9a72856">FillElement</a> (DOMElement &amp;element)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fills DOMElement according internal attributes and descendant elements. <br></td></tr>
82<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b63907af7cfccefeab209f8381962092"></a><!-- doxytag: member="UserInfo::help" ref="b63907af7cfccefeab209f8381962092" args="" -->
84<a class="el" href="classStringAttribute.html">StringAttribute</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#b63907af7cfccefeab209f8381962092">help</a></td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Explanation for an user is the only obligatory attribute. <br></td></tr>
87<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20783b9cdbef32b584be96851a8f9862"></a><!-- doxytag: member="UserInfo::elements" ref="20783b9cdbef32b584be96851a8f9862" args="" -->
89MappedElements&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#20783b9cdbef32b584be96851a8f9862">elements</a></td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">MappiLength of the output vector. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa6753c220a54aba613bfa3cc115d1c8"></a><!-- doxytag: member="UserInfo::attributes" ref="aa6753c220a54aba613bfa3cc115d1c8" args="" -->
93<a class="el" href="classAttribute.html#342750acf29e4c37d009301ef5075111">Attribute::MappedAttributes</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#aa6753c220a54aba613bfa3cc115d1c8">attributes</a></td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
96</table>
97<hr><a name="_details"></a><h2>Detailed Description</h2>
98<h3>template&lt;typename T&gt;<br>
99 class UserInfo&lt; T &gt;</h3>
100
101The main user info template class.
102<p>
103You should derive this class whenever you need new <a class="el" href="classUserInfo.html" title="The main user info template class.">UserInfo</a>. <hr>The documentation for this class was generated from the following file:<ul>
104<li>work/git/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul>
105</div>
106<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 16 17:22:11 2008 for mixpp by&nbsp;
107<a href="http://www.doxygen.org/index.html">
108<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
109</body>
110</html>
Note: See TracBrowser for help on using the browser.