root/doc/html/classCompoundUserInfo.html @ 247

Revision 234, 15.6 kB (checked in by smidl, 17 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: CompoundUserInfo&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><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>CompoundUserInfo&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="CompoundUserInfo" --><!-- doxytag: inherits="TypedUserInfo" -->The main userinfo template class. You should derive this class whenever you need a new userinfo of a class which is compound from smaller elements (all having its own userinfo class prepared). 
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 CompoundUserInfo&lt; T &gt;:</div>
34<div class="dynsection">
35<p><center><img src="classCompoundUserInfo__inherit__graph.png" border="0" usemap="#CompoundUserInfo_3_01T_01_4__inherit__map" alt="Inheritance graph"></center>
36<map name="CompoundUserInfo_3_01T_01_4__inherit__map">
37<area shape="rect" href="classCompoundUserInfo.html" title="CompoundUserInfo\&lt; Car \&gt;" alt="" coords="5,343,200,369"><area shape="rect" href="classCompoundUserInfo.html" title="CompoundUserInfo\&lt; Bike \&gt;" alt="" coords="224,343,424,369"><area shape="rect" href="classTypedUserInfo.html" title="TypeUserInfo is still an abstract class, but contrary to the UserInfo class it is..." alt="" coords="105,167,252,193"><area shape="rect" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;..." alt="" coords="141,87,216,113"><area shape="rect" href="classBindingFrame.html" title="Abstract class declaring general properties of a frame for data binding." alt="" coords="125,7,232,33"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for CompoundUserInfo&lt; T &gt;:</div>
41<div class="dynsection">
42<p><center><img src="classCompoundUserInfo__coll__graph.png" border="0" usemap="#CompoundUserInfo_3_01T_01_4__coll__map" alt="Collaboration graph"></center>
43<map name="CompoundUserInfo_3_01T_01_4__coll__map">
44<area shape="rect" href="classTypedUserInfo.html" title="TypeUserInfo is still an abstract class, but contrary to the UserInfo class it is..." alt="" coords="83,295,229,321"><area shape="rect" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;..." alt="" coords="119,215,193,241"><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="classCompoundUserInfo-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;<a class="el" href="classTypedUserInfo.html#c7ad10a9ff002383518155c965ade85c">instance</a>, 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;<a class="el" href="classTypedUserInfo.html#c7ad10a9ff002383518155c965ade85c">instance</a>, 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="e2265e447e2f48550c5d8d479119bbb3"></a><!-- doxytag: member="CompoundUserInfo::CompoundUserInfo" ref="e2265e447e2f48550c5d8d479119bbb3" args="(string userFriendlyTypeName)" -->
62&nbsp;</td><td class="memItemRight" valign="bottom"><b>CompoundUserInfo</b> (string userFriendlyTypeName)</td></tr>
63
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2244bd5181c3d1e70f3a6be2b72e9424"></a><!-- doxytag: member="CompoundUserInfo::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="CompoundUserInfo::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 colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTypedUserInfo.html">TypedUserInfo</a>&lt; T &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTypedUserInfo.html#c7ad10a9ff002383518155c965ade85c">instance</a></td></tr>
73
74<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCompoundUserInfo_1_1BindedElement.html">BindedElement</a></td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Templated class binding inner element with its XML tag and automating data transfers in both directions.  <a href="classCompoundUserInfo_1_1BindedElement.html#_details">More...</a><br></td></tr>
78</table>
79<hr><a name="_details"></a><h2>Detailed Description</h2>
80<h3>template&lt;typename T&gt;<br>
81 class CompoundUserInfo&lt; T &gt;</h3>
82
83The main userinfo template class. You should derive this class whenever you need a new userinfo of a class which is compound from smaller elements (all having its own userinfo class prepared).
84<p>
85To bind some inner element to its own userinfo class, and also to automate its assembling and disassembling, it is necessary to create a instance of an inner templated class BindedElement&lt;T&gt;. Those attributes have to be initialized in constructor of a new compound userinfo this way:<p>
86<div class="fragment"><pre class="fragment"><span class="keyword">class </span>BikeUI: <span class="keyword">public</span> <a class="code" href="classCompoundUserInfo.html" title="The main userinfo template class. You should derive this class whenever you need...">CompoundUserInfo</a>&lt;Bike&gt;
87{
88<span class="keyword">private</span>:
89        BindedElement&lt;int&gt; year;
90        BindedElement&lt;bool&gt; lights;
91        BindedElement&lt;string&gt; manufacturer;
92<span class="keyword">public</span>:
93        BikeUI()
94                :<a class="code" href="classCompoundUserInfo.html" title="The main userinfo template class. You should derive this class whenever you need...">CompoundUserInfo</a>&lt;Bike&gt;(<span class="stringliteral">"bike"</span>),
95                year( this, <span class="stringliteral">"year"</span>, 0 ),
96                lights( this, <span class="stringliteral">"electric lights"</span>, false ),
97                manufacturer( this, <span class="stringliteral">"manufacturer"</span>, <span class="stringliteral">"unknown"</span>)
98        {
99        }
100
101        ...
102}
103</pre></div> <hr><h2>Member Function Documentation</h2>
104<a class="anchor" name="0f090c6525a3e8fb11634a553f467ede"></a><!-- doxytag: member="CompoundUserInfo::Assembly" ref="0f090c6525a3e8fb11634a553f467ede" args="(DOMElement &amp;element, const string tagName)" -->
105<div class="memitem">
106<div class="memproto">
107<div class="memtemplate">
108template&lt;class T&gt; </div>
109      <table class="memname">
110        <tr>
111          <td class="memname">static T* UserInfo::Assembly           </td>
112          <td>(</td>
113          <td class="paramtype">DOMElement &amp;&nbsp;</td>
114          <td class="paramname"> <em>element</em>, </td>
115        </tr>
116        <tr>
117          <td class="paramkey"></td>
118          <td></td>
119          <td class="paramtype">const string&nbsp;</td>
120          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
121        </tr>
122        <tr>
123          <td></td>
124          <td>)</td>
125          <td></td><td></td><td><code> [inline, static, inherited]</code></td>
126        </tr>
127      </table>
128</div>
129<div class="memdoc">
130
131<p>
132This 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.
133<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>
134
135</div>
136</div><p>
137<a class="anchor" name="1d402661b82feccb5265a70f65c242e1"></a><!-- doxytag: member="CompoundUserInfo::Disassembly" ref="1d402661b82feccb5265a70f65c242e1" args="(T &amp;instance, DOMElement &amp;element, const string tagName, const string help)" -->
138<div class="memitem">
139<div class="memproto">
140<div class="memtemplate">
141template&lt;class T&gt; </div>
142      <table class="memname">
143        <tr>
144          <td class="memname">static bool UserInfo::Disassembly           </td>
145          <td>(</td>
146          <td class="paramtype">T &amp;&nbsp;</td>
147          <td class="paramname"> <em>instance</em>, </td>
148        </tr>
149        <tr>
150          <td class="paramkey"></td>
151          <td></td>
152          <td class="paramtype">DOMElement &amp;&nbsp;</td>
153          <td class="paramname"> <em>element</em>, </td>
154        </tr>
155        <tr>
156          <td class="paramkey"></td>
157          <td></td>
158          <td class="paramtype">const string&nbsp;</td>
159          <td class="paramname"> <em>tagName</em>, </td>
160        </tr>
161        <tr>
162          <td class="paramkey"></td>
163          <td></td>
164          <td class="paramtype">const string&nbsp;</td>
165          <td class="paramname"> <em>help</em></td><td>&nbsp;</td>
166        </tr>
167        <tr>
168          <td></td>
169          <td>)</td>
170          <td></td><td></td><td><code> [inline, static, inherited]</code></td>
171        </tr>
172      </table>
173</div>
174<div class="memdoc">
175
176<p>
177This 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).
178<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>
179
180<p>Referenced by <a class="el" href="userinfo_8h-source.html#l00327">UserInfo::Disassembly()</a>, and <a class="el" href="userinfo_8h-source.html#l00479">CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::DisassemblyComponentsToXML()</a>.</p>
181
182</div>
183</div><p>
184<a class="anchor" name="917b2257abc31b94c89ef3cd270e4a42"></a><!-- doxytag: member="CompoundUserInfo::Disassembly" ref="917b2257abc31b94c89ef3cd270e4a42" args="(T &amp;instance, DOMElement &amp;element, const string tagName)" -->
185<div class="memitem">
186<div class="memproto">
187<div class="memtemplate">
188template&lt;class T&gt; </div>
189      <table class="memname">
190        <tr>
191          <td class="memname">static bool UserInfo::Disassembly           </td>
192          <td>(</td>
193          <td class="paramtype">T &amp;&nbsp;</td>
194          <td class="paramname"> <em>instance</em>, </td>
195        </tr>
196        <tr>
197          <td class="paramkey"></td>
198          <td></td>
199          <td class="paramtype">DOMElement &amp;&nbsp;</td>
200          <td class="paramname"> <em>element</em>, </td>
201        </tr>
202        <tr>
203          <td class="paramkey"></td>
204          <td></td>
205          <td class="paramtype">const string&nbsp;</td>
206          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
207        </tr>
208        <tr>
209          <td></td>
210          <td>)</td>
211          <td></td><td></td><td><code> [inline, static, inherited]</code></td>
212        </tr>
213      </table>
214</div>
215<div class="memdoc">
216
217<p>
218This 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.
219<p>References <a class="el" href="userinfo_8h-source.html#l00297">UserInfo::Disassembly()</a>.</p>
220
221</div>
222</div><p>
223<hr><h2>Member Data Documentation</h2>
224<a class="anchor" name="c7ad10a9ff002383518155c965ade85c"></a><!-- doxytag: member="CompoundUserInfo::instance" ref="c7ad10a9ff002383518155c965ade85c" args="" -->
225<div class="memitem">
226<div class="memproto">
227<div class="memtemplate">
228template&lt;typename T&gt; </div>
229      <table class="memname">
230        <tr>
231          <td class="memname">const <a class="el" href="classTypedUserInfo.html">TypedUserInfo</a>&lt;T&gt;&amp; <a class="el" href="classTypedUserInfo.html">TypedUserInfo</a>&lt; T &gt;::<a class="el" href="classTypedUserInfo.html#c7ad10a9ff002383518155c965ade85c">instance</a><code> [static, protected, inherited]</code>          </td>
232        </tr>
233      </table>
234</div>
235<div class="memdoc">
236
237<p>
238the only instance of this class (each type T has its own instance) which is used as a factory for processing related userinfos
239</div>
240</div><p>
241<hr>The documentation for this class was generated from the following file:<ul>
242<li>work/git/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul>
243</div>
244<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:50:51 2009 for mixpp by&nbsp;
245<a href="http://www.doxygen.org/index.html">
246<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
247</body>
248</html>
Note: See TracBrowser for help on using the browser.