root/doc/html/classUserInfo.html @ 255

Revision 255, 16.3 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: 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><a href="modules.html"><span>Modules</span></a></li>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<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. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="userinfo_8h-source.html">userinfo.h</a>&gt;</code>
31<p>
32<div class="dynheader">
33Inheritance diagram for UserInfo:</div>
34<div class="dynsection">
35<p><center><img src="classUserInfo__inherit__graph.png" border="0" usemap="#UserInfo__inherit__map" alt="Inheritance graph"></center>
36<map name="UserInfo__inherit__map">
37<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>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for UserInfo:</div>
41<div class="dynsection">
42<p><center><img src="classUserInfo__coll__graph.png" border="0" usemap="#UserInfo__coll__map" alt="Collaboration graph"></center>
43<map name="UserInfo__coll__map">
44<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>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classUserInfo-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
49<tr><td></td></tr>
50<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
51<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
52<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>
53
54<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
55<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>
56
57<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
58<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>
59
60<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
61<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)" -->
62&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>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr>
65<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)" -->
66string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#2244bd5181c3d1e70f3a6be2b72e9424">XMLCh2str</a> (const XMLCh *const XMLCh_str)</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function which transcodes Xerces' XMLCh-based strings into C++ strings <br></td></tr>
69<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)" -->
70string&nbsp;</td><td class="memItemRight" valign="bottom"><b>removeSpaces</b> (const string &amp;str)</td></tr>
71
72<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" -->
73virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#c6d068c261d4fc3a0a4d1305ade1483d">AssemblyComponentsFromXML</a> (DOMElement &amp;element)=0</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method parse DOMElement, finds proper DOMNode and fills binded data accordingly. <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d4dc5902ee71a473983d6a8fa3c8b7a"></a><!-- doxytag: member="UserInfo::ReleaseMemory" ref="8d4dc5902ee71a473983d6a8fa3c8b7a" args="()" -->
77virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#8d4dc5902ee71a473983d6a8fa3c8b7a">ReleaseMemory</a> ()</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A method for releasing memory allocated within the 'AssemblyComponentsFromXML()' method. <br></td></tr>
80<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>
81
82<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>StringToUIMap</b></td></tr>
84
85</table>
86<hr><a name="_details"></a><h2>Detailed Description</h2>
87<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.
88<p>
89Also, 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>
90<a class="anchor" name="0f090c6525a3e8fb11634a553f467ede"></a><!-- doxytag: member="UserInfo::Assembly" ref="0f090c6525a3e8fb11634a553f467ede" args="(DOMElement &amp;element, const string tagName)" -->
91<div class="memitem">
92<div class="memproto">
93<div class="memtemplate">
94template&lt;class T&gt; </div>
95      <table class="memname">
96        <tr>
97          <td class="memname">static T* UserInfo::Assembly           </td>
98          <td>(</td>
99          <td class="paramtype">DOMElement &amp;&nbsp;</td>
100          <td class="paramname"> <em>element</em>, </td>
101        </tr>
102        <tr>
103          <td class="paramkey"></td>
104          <td></td>
105          <td class="paramtype">const string&nbsp;</td>
106          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
107        </tr>
108        <tr>
109          <td></td>
110          <td>)</td>
111          <td></td><td></td><td><code> [inline, static]</code></td>
112        </tr>
113      </table>
114</div>
115<div class="memdoc">
116
117<p>
118This 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.
119<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>
120
121</div>
122</div><p>
123<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)" -->
124<div class="memitem">
125<div class="memproto">
126<div class="memtemplate">
127template&lt;class T&gt; </div>
128      <table class="memname">
129        <tr>
130          <td class="memname">static bool UserInfo::Disassembly           </td>
131          <td>(</td>
132          <td class="paramtype">T &amp;&nbsp;</td>
133          <td class="paramname"> <em>instance</em>, </td>
134        </tr>
135        <tr>
136          <td class="paramkey"></td>
137          <td></td>
138          <td class="paramtype">DOMElement &amp;&nbsp;</td>
139          <td class="paramname"> <em>element</em>, </td>
140        </tr>
141        <tr>
142          <td class="paramkey"></td>
143          <td></td>
144          <td class="paramtype">const string&nbsp;</td>
145          <td class="paramname"> <em>tagName</em>, </td>
146        </tr>
147        <tr>
148          <td class="paramkey"></td>
149          <td></td>
150          <td class="paramtype">const string&nbsp;</td>
151          <td class="paramname"> <em>help</em></td><td>&nbsp;</td>
152        </tr>
153        <tr>
154          <td></td>
155          <td>)</td>
156          <td></td><td></td><td><code> [inline, static]</code></td>
157        </tr>
158      </table>
159</div>
160<div class="memdoc">
161
162<p>
163This 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).
164<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>
165
166<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>
167
168</div>
169</div><p>
170<a class="anchor" name="917b2257abc31b94c89ef3cd270e4a42"></a><!-- doxytag: member="UserInfo::Disassembly" ref="917b2257abc31b94c89ef3cd270e4a42" args="(T &amp;instance, DOMElement &amp;element, const string tagName)" -->
171<div class="memitem">
172<div class="memproto">
173<div class="memtemplate">
174template&lt;class T&gt; </div>
175      <table class="memname">
176        <tr>
177          <td class="memname">static bool UserInfo::Disassembly           </td>
178          <td>(</td>
179          <td class="paramtype">T &amp;&nbsp;</td>
180          <td class="paramname"> <em>instance</em>, </td>
181        </tr>
182        <tr>
183          <td class="paramkey"></td>
184          <td></td>
185          <td class="paramtype">DOMElement &amp;&nbsp;</td>
186          <td class="paramname"> <em>element</em>, </td>
187        </tr>
188        <tr>
189          <td class="paramkey"></td>
190          <td></td>
191          <td class="paramtype">const string&nbsp;</td>
192          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
193        </tr>
194        <tr>
195          <td></td>
196          <td>)</td>
197          <td></td><td></td><td><code> [inline, static]</code></td>
198        </tr>
199      </table>
200</div>
201<div class="memdoc">
202
203<p>
204This 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.
205<p>References <a class="el" href="userinfo_8h-source.html#l00297">Disassembly()</a>.</p>
206
207</div>
208</div><p>
209<a class="anchor" name="0c207ed6e5a4c975ed5bc9a758a063ca"></a><!-- doxytag: member="UserInfo::DisassemblyComponentsToXML" ref="0c207ed6e5a4c975ed5bc9a758a063ca" args="(DOMElement &amp;element)=0" -->
210<div class="memitem">
211<div class="memproto">
212      <table class="memname">
213        <tr>
214          <td class="memname">virtual bool BindingFrame::DisassemblyComponentsToXML           </td>
215          <td>(</td>
216          <td class="paramtype">DOMElement &amp;&nbsp;</td>
217          <td class="paramname"> <em>element</em>          </td>
218          <td>&nbsp;)&nbsp;</td>
219          <td><code> [pure virtual, inherited]</code></td>
220        </tr>
221      </table>
222</div>
223<div class="memdoc">
224
225<p>
226This method reads binded data, fill them into a new DOMNode, which then appends to the passed DOMElement
227<p>Implemented in <a class="el" href="classCompoundUserInfo_1_1BindedElement.html#6ef55cedb98f5d2dbcf92730f2fed939">CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;</a>.</p>
228
229</div>
230</div><p>
231<hr>The documentation for this class was generated from the following file:<ul>
232<li>work/git/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul>
233</div>
234<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 27 16:30:36 2009 for mixpp by&nbsp;
235<a href="http://www.doxygen.org/index.html">
236<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
237</body>
238</html>
Note: See TracBrowser for help on using the browser.