root/doc/html/classUserInfo.html @ 181

Revision 181, 16.3 kB (checked in by smidl, 16 years ago)

Regenerated 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: UserInfo 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.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 Class Reference</h1><!-- doxytag: class="UserInfo" --><!-- doxytag: inherits="BindingFrame" --><a class="el" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;...">UserInfo</a> is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt; or ValuedUserInfo&lt;T&gt; instead. The raison d'etre of this class is to allow pointers to its templated descendants. 
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:</div>
33<div class="dynsection">
34<p><center><img src="classUserInfo__inherit__graph.png" border="0" usemap="#UserInfo__inherit__map" alt="Inheritance graph"></center>
35<map name="UserInfo__inherit__map">
36<area shape="rect" href="classTypedUserInfo.html" title="TypeUserInfo is still an abstract class, but contrary to the UserInfo class it is..." alt="" coords="292,211,439,237"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\&lt; double \&gt;" alt="" coords="563,185,747,212"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\&lt; int \&gt;" alt="" coords="577,360,732,387"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\&lt; string \&gt;" alt="" coords="567,436,743,463"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\&lt; Car \&gt;" alt="" coords="573,57,736,84"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\&lt; bool \&gt;" alt="" coords="571,487,739,513"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\&lt; Bike \&gt;" alt="" coords="571,7,739,33"><area shape="rect" href="classBindingFrame.html" title="Abstract class declaring general properties of a frame for data binding." alt="" coords="7,211,113,237"><area shape="rect" href="classCompoundUserInfo.html" title="The main userinfo template class. You should derive this class whenever you need..." alt="" coords="564,135,745,161"><area shape="rect" href="classValuedUserInfo.html" title="The main userinfo template class. It should be derived whenever you need a new userinfo..." alt="" coords="577,268,732,295"><area shape="rect" href="classCompoundUserInfo.html" title="CompoundUserInfo\&lt; Car \&gt;" alt="" coords="873,135,1068,161"><area shape="rect" href="classCompoundUserInfo.html" title="CompoundUserInfo\&lt; Bike \&gt;" alt="" coords="871,49,1071,76"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\&lt; double \&gt;" alt="" coords="876,203,1065,229"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\&lt; int \&gt;" alt="" coords="889,301,1052,328"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\&lt; string \&gt;" alt="" coords="879,368,1063,395"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\&lt; bool \&gt;" alt="" coords="884,436,1057,463"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for UserInfo:</div>
40<div class="dynsection">
41<p><center><img src="classUserInfo__coll__graph.png" border="0" usemap="#UserInfo__coll__map" alt="Collaboration graph"></center>
42<map name="UserInfo__coll__map">
43<area shape="rect" href="classBindingFrame.html" title="Abstract class declaring general properties of a frame for data binding." alt="" coords="24,103,131,129"><area shape="rect" href="classAssertXercesIsAlive.html" title="Class initializing Xerces library." alt="" coords="5,7,149,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>Static Public Member Functions</h2></td></tr>
50<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
51<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classUserInfo.html#0f090c6525a3e8fb11634a553f467ede">Assembly</a> (DOMElement &amp;element, const string tagName)</td></tr>
52
53<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
54<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classUserInfo.html#1d402661b82feccb5265a70f65c242e1">Disassembly</a> (T &amp;instance, DOMElement &amp;element, const string tagName, const string help)</td></tr>
55
56<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
57<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classUserInfo.html#917b2257abc31b94c89ef3cd270e4a42">Disassembly</a> (T &amp;instance, DOMElement &amp;element, const string tagName)</td></tr>
58
59<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0bccb19c6b819cf9f763e985c573ae8f"></a><!-- doxytag: member="UserInfo::UserInfo" ref="0bccb19c6b819cf9f763e985c573ae8f" args="(const string &amp;userFriendlyTypeName, const string &amp;typeNameByRTTI)" -->
61&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#0bccb19c6b819cf9f763e985c573ae8f">UserInfo</a> (const string &amp;userFriendlyTypeName, const string &amp;typeNameByRTTI)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2244bd5181c3d1e70f3a6be2b72e9424"></a><!-- doxytag: member="UserInfo::XMLCh2str" ref="2244bd5181c3d1e70f3a6be2b72e9424" args="(const XMLCh *const XMLCh_str)" -->
65string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#2244bd5181c3d1e70f3a6be2b72e9424">XMLCh2str</a> (const XMLCh *const XMLCh_str)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function which transcodes Xerces' XMLCh-based strings into C++ strings <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="820e4df85c0dc545e3079e407fcdbbaa"></a><!-- doxytag: member="UserInfo::removeSpaces" ref="820e4df85c0dc545e3079e407fcdbbaa" args="(const string &amp;str)" -->
69string&nbsp;</td><td class="memItemRight" valign="bottom"><b>removeSpaces</b> (const string &amp;<a class="el" href="classstr.html">str</a>)</td></tr>
70
71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6d068c261d4fc3a0a4d1305ade1483d"></a><!-- doxytag: member="UserInfo::AssemblyComponentsFromXML" ref="c6d068c261d4fc3a0a4d1305ade1483d" args="(DOMElement &amp;element)=0" -->
72virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#c6d068c261d4fc3a0a4d1305ade1483d">AssemblyComponentsFromXML</a> (DOMElement &amp;element)=0</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method parse DOMElement, finds proper DOMNode and fills binded data accordingly. <br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d4dc5902ee71a473983d6a8fa3c8b7a"></a><!-- doxytag: member="UserInfo::ReleaseMemory" ref="8d4dc5902ee71a473983d6a8fa3c8b7a" args="()" -->
76virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#8d4dc5902ee71a473983d6a8fa3c8b7a">ReleaseMemory</a> ()</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A method for releasing memory allocated within the 'AssemblyComponentsFromXML()' method. <br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#0c207ed6e5a4c975ed5bc9a758a063ca">DisassemblyComponentsToXML</a> (DOMElement &amp;element)=0</td></tr>
80
81<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>StringToUIMap</b></td></tr>
83
84</table>
85<hr><a name="_details"></a><h2>Detailed Description</h2>
86<a class="el" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;...">UserInfo</a> is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt; or ValuedUserInfo&lt;T&gt; instead. The raison d'etre of this class is to allow pointers to its templated descendants.
87<p>
88Also, the main functions of the whole <a class="el" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;...">UserInfo</a> library are included within this class, see static methods 'Assembly' and 'Disassembly'. <hr><h2>Member Function Documentation</h2>
89<a class="anchor" name="0f090c6525a3e8fb11634a553f467ede"></a><!-- doxytag: member="UserInfo::Assembly" ref="0f090c6525a3e8fb11634a553f467ede" args="(DOMElement &amp;element, const string tagName)" -->
90<div class="memitem">
91<div class="memproto">
92<div class="memtemplate">
93template&lt;class T&gt; </div>
94      <table class="memname">
95        <tr>
96          <td class="memname">static T* UserInfo::Assembly           </td>
97          <td>(</td>
98          <td class="paramtype">DOMElement &amp;&nbsp;</td>
99          <td class="paramname"> <em>element</em>, </td>
100        </tr>
101        <tr>
102          <td class="paramkey"></td>
103          <td></td>
104          <td class="paramtype">const string&nbsp;</td>
105          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
106        </tr>
107        <tr>
108          <td></td>
109          <td>)</td>
110          <td></td><td></td><td><code> [inline, static]</code></td>
111        </tr>
112      </table>
113</div>
114<div class="memdoc">
115
116<p>
117This methods tries to assembly a new instance of type T (or some of its descendant types) according to a data stored in a DOMNode named tagName within a child nodes of the passed element. If an error occurs, it returns a NULL pointer.
118<p>References <a class="el" href="userinfo_8cpp-source.html#l00040">Attribute::Get()</a>, and <a class="el" href="userinfo_8h-source.html#l00152">Attribute::type</a>.</p>
119
120</div>
121</div><p>
122<a class="anchor" name="1d402661b82feccb5265a70f65c242e1"></a><!-- doxytag: member="UserInfo::Disassembly" ref="1d402661b82feccb5265a70f65c242e1" args="(T &amp;instance, DOMElement &amp;element, const string tagName, const string help)" -->
123<div class="memitem">
124<div class="memproto">
125<div class="memtemplate">
126template&lt;class T&gt; </div>
127      <table class="memname">
128        <tr>
129          <td class="memname">static bool UserInfo::Disassembly           </td>
130          <td>(</td>
131          <td class="paramtype">T &amp;&nbsp;</td>
132          <td class="paramname"> <em>instance</em>, </td>
133        </tr>
134        <tr>
135          <td class="paramkey"></td>
136          <td></td>
137          <td class="paramtype">DOMElement &amp;&nbsp;</td>
138          <td class="paramname"> <em>element</em>, </td>
139        </tr>
140        <tr>
141          <td class="paramkey"></td>
142          <td></td>
143          <td class="paramtype">const string&nbsp;</td>
144          <td class="paramname"> <em>tagName</em>, </td>
145        </tr>
146        <tr>
147          <td class="paramkey"></td>
148          <td></td>
149          <td class="paramtype">const string&nbsp;</td>
150          <td class="paramname"> <em>help</em></td><td>&nbsp;</td>
151        </tr>
152        <tr>
153          <td></td>
154          <td>)</td>
155          <td></td><td></td><td><code> [inline, static]</code></td>
156        </tr>
157      </table>
158</div>
159<div class="memdoc">
160
161<p>
162This methods tries to disassembly an instance of type T (or some of its descendant types) and build DOM tree accordingly. Then, it creates a new DOMNode named according tagName and connecti it to the passed DOMElement as a new child node (with a help attribute filled).
163<p>References <a class="el" href="userinfo_8h-source.html#l00149">Attribute::help</a>, <a class="el" href="userinfo_8cpp-source.html#l00046">Attribute::Set()</a>, and <a class="el" href="userinfo_8h-source.html#l00152">Attribute::type</a>.</p>
164
165<p>Referenced by <a class="el" href="userinfo_8h-source.html#l00327">Disassembly()</a>, and <a class="el" href="userinfo_8h-source.html#l00479">CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::DisassemblyComponentsToXML()</a>.</p>
166
167</div>
168</div><p>
169<a class="anchor" name="917b2257abc31b94c89ef3cd270e4a42"></a><!-- doxytag: member="UserInfo::Disassembly" ref="917b2257abc31b94c89ef3cd270e4a42" args="(T &amp;instance, DOMElement &amp;element, const string tagName)" -->
170<div class="memitem">
171<div class="memproto">
172<div class="memtemplate">
173template&lt;class T&gt; </div>
174      <table class="memname">
175        <tr>
176          <td class="memname">static bool UserInfo::Disassembly           </td>
177          <td>(</td>
178          <td class="paramtype">T &amp;&nbsp;</td>
179          <td class="paramname"> <em>instance</em>, </td>
180        </tr>
181        <tr>
182          <td class="paramkey"></td>
183          <td></td>
184          <td class="paramtype">DOMElement &amp;&nbsp;</td>
185          <td class="paramname"> <em>element</em>, </td>
186        </tr>
187        <tr>
188          <td class="paramkey"></td>
189          <td></td>
190          <td class="paramtype">const string&nbsp;</td>
191          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
192        </tr>
193        <tr>
194          <td></td>
195          <td>)</td>
196          <td></td><td></td><td><code> [inline, static]</code></td>
197        </tr>
198      </table>
199</div>
200<div class="memdoc">
201
202<p>
203This methods tries to disassembly an instance of type T (or some of its descendant types) and build DOM tree accordingly. Then, it creates a new DOMNode named according tagName and connecti it to the passed DOMElement as a new child node.
204<p>References <a class="el" href="userinfo_8h-source.html#l00297">Disassembly()</a>.</p>
205
206</div>
207</div><p>
208<a class="anchor" name="0c207ed6e5a4c975ed5bc9a758a063ca"></a><!-- doxytag: member="UserInfo::DisassemblyComponentsToXML" ref="0c207ed6e5a4c975ed5bc9a758a063ca" args="(DOMElement &amp;element)=0" -->
209<div class="memitem">
210<div class="memproto">
211      <table class="memname">
212        <tr>
213          <td class="memname">virtual bool BindingFrame::DisassemblyComponentsToXML           </td>
214          <td>(</td>
215          <td class="paramtype">DOMElement &amp;&nbsp;</td>
216          <td class="paramname"> <em>element</em>          </td>
217          <td>&nbsp;)&nbsp;</td>
218          <td><code> [pure virtual, inherited]</code></td>
219        </tr>
220      </table>
221</div>
222<div class="memdoc">
223
224<p>
225This method reads binded data, fill them into a new DOMNode, which then appends to the passed DOMElement
226<p>Implemented in <a class="el" href="classCompoundUserInfo_1_1BindedElement.html#6ef55cedb98f5d2dbcf92730f2fed939">CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;</a>.</p>
227
228</div>
229</div><p>
230<hr>The documentation for this class was generated from the following file:<ul>
231<li>work/git/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul>
232</div>
233<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 15 15:57:17 2008 for mixpp by&nbsp;
234<a href="http://www.doxygen.org/index.html">
235<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
236</body>
237</html>
Note: See TracBrowser for help on using the browser.