root/doc/html/classValuedUserInfo.html @ 261

Revision 261, 15.5 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[139]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">
[171]3<title>mixpp: ValuedUserInfo&lt; T &gt; Class Template Reference</title>
[139]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>
[219]13      <li><a href="modules.html"><span>Modules</span></a></li>
[261]14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
[139]16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
[261]21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
[139]22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27</div>
28<div class="contents">
[171]29<h1>ValuedUserInfo&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="ValuedUserInfo" --><!-- doxytag: inherits="TypedUserInfo" -->The main userinfo template class. It should be derived whenever you need a new userinfo of a class which does not contain any subelements. It is the case of basic classes(or types) like int, string, double, etc. 
[139]30<a href="#_details">More...</a>
31<p>
32<code>#include &lt;<a class="el" href="userinfo_8h-source.html">userinfo.h</a>&gt;</code>
33<p>
34<div class="dynheader">
[171]35Inheritance diagram for ValuedUserInfo&lt; T &gt;:</div>
[139]36<div class="dynsection">
[171]37<p><center><img src="classValuedUserInfo__inherit__graph.png" border="0" usemap="#ValuedUserInfo_3_01T_01_4__inherit__map" alt="Inheritance graph"></center>
38<map name="ValuedUserInfo_3_01T_01_4__inherit__map">
39<area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\&lt; double \&gt;" alt="" coords="769,5,959,32"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\&lt; int \&gt;" alt="" coords="783,56,945,83"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\&lt; string \&gt;" alt="" coords="772,107,956,133"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\&lt; bool \&gt;" alt="" coords="777,157,951,184"><area shape="rect" href="classTypedUserInfo.html" title="TypeUserInfo is still an abstract class, but contrary to the UserInfo class it is..." alt="" coords="292,83,439,109"><area shape="rect" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;..." alt="" coords="165,83,240,109"><area shape="rect" href="classBindingFrame.html" title="Abstract class declaring general properties of a frame for data binding." alt="" coords="7,83,113,109"></map>
[139]40<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
41<div class="dynheader">
[171]42Collaboration diagram for ValuedUserInfo&lt; T &gt;:</div>
[139]43<div class="dynsection">
[171]44<p><center><img src="classValuedUserInfo__coll__graph.png" border="0" usemap="#ValuedUserInfo_3_01T_01_4__coll__map" alt="Collaboration graph"></center>
45<map name="ValuedUserInfo_3_01T_01_4__coll__map">
46<area shape="rect" href="classTypedUserInfo.html" title="TypeUserInfo is still an abstract class, but contrary to the UserInfo class it is..." alt="" coords="79,311,225,337"><area shape="rect" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;..." alt="" coords="84,215,159,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>
[139]47<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
48
49<p>
[171]50<a href="classValuedUserInfo-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
[139]51<tr><td></td></tr>
[162]52<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
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 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>
[139]55
[162]56<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
[171]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#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>
[139]58
[162]59<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
[171]60<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>
[139]61
[162]62<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
[171]63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="86897fcfe4666183bcecf16a23715cdb"></a><!-- doxytag: member="ValuedUserInfo::ValuedUserInfo" ref="86897fcfe4666183bcecf16a23715cdb" args="(string userFriendlyTypeName)" -->
64&nbsp;</td><td class="memItemRight" valign="bottom"><b>ValuedUserInfo</b> (string userFriendlyTypeName)</td></tr>
[139]65
[171]66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2244bd5181c3d1e70f3a6be2b72e9424"></a><!-- doxytag: member="ValuedUserInfo::XMLCh2str" ref="2244bd5181c3d1e70f3a6be2b72e9424" args="(const XMLCh *const XMLCh_str)" -->
[162]67string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#2244bd5181c3d1e70f3a6be2b72e9424">XMLCh2str</a> (const XMLCh *const XMLCh_str)</td></tr>
[139]68
[162]69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function which transcodes Xerces' XMLCh-based strings into C++ strings <br></td></tr>
[171]70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="820e4df85c0dc545e3079e407fcdbbaa"></a><!-- doxytag: member="ValuedUserInfo::removeSpaces" ref="820e4df85c0dc545e3079e407fcdbbaa" args="(const string &amp;str)" -->
[255]71string&nbsp;</td><td class="memItemRight" valign="bottom"><b>removeSpaces</b> (const string &amp;str)</td></tr>
[139]72
[171]73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d4dc5902ee71a473983d6a8fa3c8b7a"></a><!-- doxytag: member="ValuedUserInfo::ReleaseMemory" ref="8d4dc5902ee71a473983d6a8fa3c8b7a" args="()" -->
[162]74virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#8d4dc5902ee71a473983d6a8fa3c8b7a">ReleaseMemory</a> ()</td></tr>
[139]75
[162]76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A method for releasing memory allocated within the 'AssemblyComponentsFromXML()' method. <br></td></tr>
[171]77<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10a0acb3696018386451881ebcc797ea"></a><!-- doxytag: member="ValuedUserInfo::value" ref="10a0acb3696018386451881ebcc797ea" args="" -->
79string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classValuedUserInfo.html#10a0acb3696018386451881ebcc797ea">value</a></td></tr>
[139]80
[171]81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">string variable which is automatically binded to a proper DOMElement attribute <br></td></tr>
82<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
83<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>
[139]84
85</table>
86<hr><a name="_details"></a><h2>Detailed Description</h2>
[171]87<h3>template&lt;typename T&gt;<br>
88 class ValuedUserInfo&lt; T &gt;</h3>
89
90The main userinfo template class. It should be derived whenever you need a new userinfo of a class which does not contain any subelements. It is the case of basic classes(or types) like int, string, double, etc.
[162]91<p>
[171]92The only thing left is to translate its public string attribute 'value' into a value of type T and also implement conversion in the other way round. For that, an overloading of methods T* AssemblyInstance() / bool DisassemblyInstance(T  &amp;instance) is fruitful. See some valued userinfo below as an example. <hr><h2>Member Function Documentation</h2>
93<a class="anchor" name="0f090c6525a3e8fb11634a553f467ede"></a><!-- doxytag: member="ValuedUserInfo::Assembly" ref="0f090c6525a3e8fb11634a553f467ede" args="(DOMElement &amp;element, const string tagName)" -->
[162]94<div class="memitem">
95<div class="memproto">
96<div class="memtemplate">
97template&lt;class T&gt; </div>
98      <table class="memname">
99        <tr>
100          <td class="memname">static T* UserInfo::Assembly           </td>
101          <td>(</td>
102          <td class="paramtype">DOMElement &amp;&nbsp;</td>
103          <td class="paramname"> <em>element</em>, </td>
104        </tr>
105        <tr>
106          <td class="paramkey"></td>
107          <td></td>
108          <td class="paramtype">const string&nbsp;</td>
109          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
110        </tr>
111        <tr>
112          <td></td>
113          <td>)</td>
[171]114          <td></td><td></td><td><code> [inline, static, inherited]</code></td>
[162]115        </tr>
116      </table>
117</div>
118<div class="memdoc">
[139]119
120<p>
[162]121This 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.
122<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>
123
124</div>
125</div><p>
[171]126<a class="anchor" name="1d402661b82feccb5265a70f65c242e1"></a><!-- doxytag: member="ValuedUserInfo::Disassembly" ref="1d402661b82feccb5265a70f65c242e1" args="(T &amp;instance, DOMElement &amp;element, const string tagName, const string help)" -->
[162]127<div class="memitem">
128<div class="memproto">
129<div class="memtemplate">
130template&lt;class T&gt; </div>
131      <table class="memname">
132        <tr>
133          <td class="memname">static bool UserInfo::Disassembly           </td>
134          <td>(</td>
135          <td class="paramtype">T &amp;&nbsp;</td>
136          <td class="paramname"> <em>instance</em>, </td>
137        </tr>
138        <tr>
139          <td class="paramkey"></td>
140          <td></td>
141          <td class="paramtype">DOMElement &amp;&nbsp;</td>
142          <td class="paramname"> <em>element</em>, </td>
143        </tr>
144        <tr>
145          <td class="paramkey"></td>
146          <td></td>
147          <td class="paramtype">const string&nbsp;</td>
148          <td class="paramname"> <em>tagName</em>, </td>
149        </tr>
150        <tr>
151          <td class="paramkey"></td>
152          <td></td>
153          <td class="paramtype">const string&nbsp;</td>
154          <td class="paramname"> <em>help</em></td><td>&nbsp;</td>
155        </tr>
156        <tr>
157          <td></td>
158          <td>)</td>
[171]159          <td></td><td></td><td><code> [inline, static, inherited]</code></td>
[162]160        </tr>
161      </table>
162</div>
163<div class="memdoc">
164
165<p>
166This 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).
167<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>
168
[171]169<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>
[162]170
171</div>
172</div><p>
[171]173<a class="anchor" name="917b2257abc31b94c89ef3cd270e4a42"></a><!-- doxytag: member="ValuedUserInfo::Disassembly" ref="917b2257abc31b94c89ef3cd270e4a42" args="(T &amp;instance, DOMElement &amp;element, const string tagName)" -->
[162]174<div class="memitem">
175<div class="memproto">
176<div class="memtemplate">
177template&lt;class T&gt; </div>
178      <table class="memname">
179        <tr>
180          <td class="memname">static bool UserInfo::Disassembly           </td>
181          <td>(</td>
182          <td class="paramtype">T &amp;&nbsp;</td>
183          <td class="paramname"> <em>instance</em>, </td>
184        </tr>
185        <tr>
186          <td class="paramkey"></td>
187          <td></td>
188          <td class="paramtype">DOMElement &amp;&nbsp;</td>
189          <td class="paramname"> <em>element</em>, </td>
190        </tr>
191        <tr>
192          <td class="paramkey"></td>
193          <td></td>
194          <td class="paramtype">const string&nbsp;</td>
195          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
196        </tr>
197        <tr>
198          <td></td>
199          <td>)</td>
[171]200          <td></td><td></td><td><code> [inline, static, inherited]</code></td>
[162]201        </tr>
202      </table>
203</div>
204<div class="memdoc">
205
206<p>
207This 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.
[171]208<p>References <a class="el" href="userinfo_8h-source.html#l00297">UserInfo::Disassembly()</a>.</p>
[162]209
210</div>
211</div><p>
[171]212<hr><h2>Member Data Documentation</h2>
213<a class="anchor" name="c7ad10a9ff002383518155c965ade85c"></a><!-- doxytag: member="ValuedUserInfo::instance" ref="c7ad10a9ff002383518155c965ade85c" args="" -->
[162]214<div class="memitem">
215<div class="memproto">
[171]216<div class="memtemplate">
217template&lt;typename T&gt; </div>
[162]218      <table class="memname">
219        <tr>
[171]220          <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>
[162]221        </tr>
222      </table>
223</div>
224<div class="memdoc">
225
226<p>
[171]227the only instance of this class (each type T has its own instance) which is used as a factory for processing related userinfos
[162]228</div>
229</div><p>
230<hr>The documentation for this class was generated from the following file:<ul>
[261]231<li><a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul>
[139]232</div>
[261]233<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 15:29:50 2009 for mixpp by&nbsp;
[139]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.