root/doc/xml/classValuedUserInfo.xml @ 235

Revision 187, 22.1 kB (checked in by smidl, 16 years ago)

doc

Line 
1<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
3  <compounddef id="classValuedUserInfo" kind="class" prot="public">
4    <compoundname>ValuedUserInfo</compoundname>
5    <basecompoundref refid="classTypedUserInfo" prot="public" virt="non-virtual">TypedUserInfo&lt; T &gt;</basecompoundref>
6    <includes refid="userinfo_8h" local="no">userinfo.h</includes>
7    <templateparamlist>
8      <param>
9        <type>typename</type>
10        <declname>T</declname>
11        <defname>T</defname>
12      </param>
13    </templateparamlist>
14      <sectiondef kind="protected-attrib">
15      <memberdef kind="variable" id="classValuedUserInfo_110a0acb3696018386451881ebcc797ea" prot="protected" static="no" mutable="no">
16        <type>string</type>
17        <definition>string ValuedUserInfo&lt; T &gt;::value</definition>
18        <argsstring></argsstring>
19        <name>value</name>
20        <briefdescription>
21<para>string variable which is automatically binded to a proper DOMElement attribute </para>        </briefdescription>
22        <detaileddescription>
23        </detaileddescription>
24        <inbodydescription>
25        </inbodydescription>
26        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="552" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="552" bodyend="-1"/>
27      </memberdef>
28      </sectiondef>
29      <sectiondef kind="private-func">
30      <memberdef kind="function" id="classValuedUserInfo_18d9c6bf7f1b043fcd8d3f375f49948e9" prot="private" static="no" const="no" explicit="no" inline="yes" virt="virtual">
31        <type>void</type>
32        <definition>void ValuedUserInfo&lt; T &gt;::AssemblyComponentsFromXML</definition>
33        <argsstring>(DOMElement &amp;element)</argsstring>
34        <name>AssemblyComponentsFromXML</name>
35        <reimplements refid="classBindingFrame_1c6d068c261d4fc3a0a4d1305ade1483d">AssemblyComponentsFromXML</reimplements>
36        <param>
37          <type>DOMElement &amp;</type>
38          <declname>element</declname>
39        </param>
40        <briefdescription>
41<para>This method parse DOMElement, finds proper DOMNode and fills binded data accordingly. </para>        </briefdescription>
42        <detaileddescription>
43        </detaileddescription>
44        <inbodydescription>
45        </inbodydescription>
46        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="531" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="530" bodyend="533"/>
47      </memberdef>
48      <memberdef kind="function" id="classValuedUserInfo_18dbc439e17a251934160bc505bcaa4a4" prot="private" static="no" const="no" explicit="no" inline="yes" virt="virtual">
49        <type>bool</type>
50        <definition>bool ValuedUserInfo&lt; T &gt;::DisassemblyComponentsToXML</definition>
51        <argsstring>(DOMElement &amp;element)</argsstring>
52        <name>DisassemblyComponentsToXML</name>
53        <reimplements refid="classBindingFrame_10c207ed6e5a4c975ed5bc9a758a063ca">DisassemblyComponentsToXML</reimplements>
54        <param>
55          <type>DOMElement &amp;</type>
56          <declname>element</declname>
57        </param>
58        <briefdescription>
59        </briefdescription>
60        <detaileddescription>
61<para>This method reads binded data, fill them into a new DOMNode, which then appends to the passed DOMElement </para>        </detaileddescription>
62        <inbodydescription>
63        </inbodydescription>
64        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="536" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="535" bodyend="539"/>
65      </memberdef>
66      </sectiondef>
67      <sectiondef kind="protected-func">
68      <memberdef kind="function" id="classValuedUserInfo_186897fcfe4666183bcecf16a23715cdb" prot="protected" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
69        <type></type>
70        <definition>ValuedUserInfo&lt; T &gt;::ValuedUserInfo</definition>
71        <argsstring>(string userFriendlyTypeName)</argsstring>
72        <name>ValuedUserInfo</name>
73        <param>
74          <type>string</type>
75          <declname>userFriendlyTypeName</declname>
76        </param>
77        <briefdescription>
78        </briefdescription>
79        <detaileddescription>
80        </detaileddescription>
81        <inbodydescription>
82        </inbodydescription>
83        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="544"/>
84      </memberdef>
85      <memberdef kind="function" id="classValuedUserInfo_14c37684500f88a6d7d8d06b73ab5267a" prot="protected" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
86        <type></type>
87        <definition>ValuedUserInfo&lt; T &gt;::~ValuedUserInfo</definition>
88        <argsstring>()</argsstring>
89        <name>~ValuedUserInfo</name>
90        <briefdescription>
91        </briefdescription>
92        <detaileddescription>
93        </detaileddescription>
94        <inbodydescription>
95        </inbodydescription>
96        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="548"/>
97      </memberdef>
98      <memberdef kind="function" id="classBindingFrame_12244bd5181c3d1e70f3a6be2b72e9424" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
99        <type>string</type>
100        <definition>string BindingFrame::XMLCh2str</definition>
101        <argsstring>(const XMLCh *const XMLCh_str)</argsstring>
102        <name>XMLCh2str</name>
103        <param>
104          <type>const XMLCh *const </type>
105          <declname>XMLCh_str</declname>
106        </param>
107        <briefdescription>
108<para>function which transcodes Xerces&apos; XMLCh-based strings into C++ strings </para>        </briefdescription>
109        <detaileddescription>
110        </detaileddescription>
111        <inbodydescription>
112        </inbodydescription>
113        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="99" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="20" bodyend="26"/>
114      </memberdef>
115      <memberdef kind="function" id="classBindingFrame_1820e4df85c0dc545e3079e407fcdbbaa" prot="protected" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
116        <type>string</type>
117        <definition>string BindingFrame::removeSpaces</definition>
118        <argsstring>(const string &amp;str)</argsstring>
119        <name>removeSpaces</name>
120        <param>
121          <type>const string &amp;</type>
122          <declname>str</declname>
123        </param>
124        <briefdescription>
125        </briefdescription>
126        <detaileddescription>
127        </detaileddescription>
128        <inbodydescription>
129        </inbodydescription>
130        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="102" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="101" bodyend="108"/>
131      </memberdef>
132      <memberdef kind="function" id="classBindingFrame_18d4dc5902ee71a473983d6a8fa3c8b7a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
133        <type>void</type>
134        <definition>virtual void BindingFrame::ReleaseMemory</definition>
135        <argsstring>()</argsstring>
136        <name>ReleaseMemory</name>
137        <reimplementedby refid="classCompoundUserInfo_1db347fdb53198e3a44ecdeddced6e273">ReleaseMemory</reimplementedby>
138        <reimplementedby refid="classCompoundUserInfo_1db347fdb53198e3a44ecdeddced6e273">ReleaseMemory</reimplementedby>
139        <reimplementedby refid="classCompoundUserInfo_1db347fdb53198e3a44ecdeddced6e273">ReleaseMemory</reimplementedby>
140        <reimplementedby refid="classCompoundUserInfo_1_1BindedElement_1e5a47de35cae44540b02d4c12fde54e4">ReleaseMemory</reimplementedby>
141        <briefdescription>
142<para>A method for releasing memory allocated within the &apos;AssemblyComponentsFromXML()&apos; method. </para>        </briefdescription>
143        <detaileddescription>
144        </detaileddescription>
145        <inbodydescription>
146        </inbodydescription>
147        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="115" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="115" bodyend="115"/>
148      </memberdef>
149      </sectiondef>
150      <sectiondef kind="protected-static-attrib">
151      <memberdef kind="variable" id="classTypedUserInfo_1c7ad10a9ff002383518155c965ade85c" prot="protected" static="yes" mutable="no">
152        <type>const <ref refid="classTypedUserInfo" kindref="compound">TypedUserInfo</ref>&lt; T &gt; &amp;</type>
153        <definition>const TypedUserInfo&lt;T&gt;&amp; TypedUserInfo&lt; T &gt;::instance</definition>
154        <argsstring></argsstring>
155        <name>instance</name>
156        <briefdescription>
157        </briefdescription>
158        <detaileddescription>
159<para>the only instance of this class (each type T has its own instance) which is used as a factory for processing related userinfos </para>        </detaileddescription>
160        <inbodydescription>
161        </inbodydescription>
162        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="387" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="387" bodyend="-1"/>
163      </memberdef>
164      </sectiondef>
165      <sectiondef kind="public-static-func">
166      <memberdef kind="function" id="classUserInfo_10f090c6525a3e8fb11634a553f467ede" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
167        <templateparamlist>
168          <param>
169            <type>class</type>
170            <declname>T</declname>
171            <defname>T</defname>
172          </param>
173        </templateparamlist>
174        <type>T *</type>
175        <definition>static T* UserInfo::Assembly</definition>
176        <argsstring>(DOMElement &amp;element, const string tagName)</argsstring>
177        <name>Assembly</name>
178        <param>
179          <type>DOMElement &amp;</type>
180          <declname>element</declname>
181        </param>
182        <param>
183          <type>const string</type>
184          <declname>tagName</declname>
185        </param>
186        <briefdescription>
187        </briefdescription>
188        <detaileddescription>
189<para>This 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. </para>        </detaileddescription>
190        <inbodydescription>
191        </inbodydescription>
192        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="227" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="226" bodyend="291"/>
193        <references refid="classAttribute_16ebbcaaf9c90a979e645f469e02bb940" compoundref="userinfo_8cpp" startline="40" endline="44">Attribute::Get</references>
194        <references refid="classAttribute_15f6cce980606fa8943857204aacb5478" compoundref="userinfo_8h" startline="152">Attribute::type</references>
195      </memberdef>
196      <memberdef kind="function" id="classUserInfo_11d402661b82feccb5265a70f65c242e1" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
197        <templateparamlist>
198          <param>
199            <type>class</type>
200            <declname>T</declname>
201            <defname>T</defname>
202          </param>
203        </templateparamlist>
204        <type>bool</type>
205        <definition>static bool UserInfo::Disassembly</definition>
206        <argsstring>(T &amp;instance, DOMElement &amp;element, const string tagName, const string help)</argsstring>
207        <name>Disassembly</name>
208        <param>
209          <type>T &amp;</type>
210          <declname>instance</declname>
211        </param>
212        <param>
213          <type>DOMElement &amp;</type>
214          <declname>element</declname>
215        </param>
216        <param>
217          <type>const string</type>
218          <declname>tagName</declname>
219        </param>
220        <param>
221          <type>const string</type>
222          <declname>help</declname>
223        </param>
224        <briefdescription>
225        </briefdescription>
226        <detaileddescription>
227<para>This 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). </para>        </detaileddescription>
228        <inbodydescription>
229        </inbodydescription>
230        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="298" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="297" bodyend="321"/>
231        <references refid="classAttribute_1d6474fd976f505e70e10c497199c6770" compoundref="userinfo_8h" startline="149">Attribute::help</references>
232        <references refid="classAttribute_1e011d84e2e3c40390807a8b8e58e3c35" compoundref="userinfo_8cpp" startline="46" endline="52">Attribute::Set</references>
233        <references refid="classAttribute_15f6cce980606fa8943857204aacb5478" compoundref="userinfo_8h" startline="152">Attribute::type</references>
234        <referencedby refid="classUserInfo_1917b2257abc31b94c89ef3cd270e4a42" compoundref="userinfo_8h" startline="327" endline="330">UserInfo::Disassembly</referencedby>
235        <referencedby refid="classCompoundUserInfo_1_1BindedElement_16ef55cedb98f5d2dbcf92730f2fed939" compoundref="userinfo_8h" startline="479" endline="482">CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::DisassemblyComponentsToXML</referencedby>
236      </memberdef>
237      <memberdef kind="function" id="classUserInfo_1917b2257abc31b94c89ef3cd270e4a42" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
238        <templateparamlist>
239          <param>
240            <type>class</type>
241            <declname>T</declname>
242            <defname>T</defname>
243          </param>
244        </templateparamlist>
245        <type>bool</type>
246        <definition>static bool UserInfo::Disassembly</definition>
247        <argsstring>(T &amp;instance, DOMElement &amp;element, const string tagName)</argsstring>
248        <name>Disassembly</name>
249        <param>
250          <type>T &amp;</type>
251          <declname>instance</declname>
252        </param>
253        <param>
254          <type>DOMElement &amp;</type>
255          <declname>element</declname>
256        </param>
257        <param>
258          <type>const string</type>
259          <declname>tagName</declname>
260        </param>
261        <briefdescription>
262        </briefdescription>
263        <detaileddescription>
264<para>This 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. </para>        </detaileddescription>
265        <inbodydescription>
266        </inbodydescription>
267        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="328" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="327" bodyend="330"/>
268        <references refid="classUserInfo_11d402661b82feccb5265a70f65c242e1" compoundref="userinfo_8h" startline="297" endline="321">UserInfo::Disassembly</references>
269      </memberdef>
270      </sectiondef>
271    <briefdescription>
272<para>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. </para>    </briefdescription>
273    <detaileddescription>
274<para>The only thing left is to translate its public string attribute &apos;value&apos; 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. </para>    </detaileddescription>
275    <inheritancegraph>
276      <node id="1381">
277        <label>ValuedUserInfo&lt; int &gt;</label>
278        <link refid="classValuedUserInfo"/>
279        <childnode refid="1375" relation="template-instance">
280          <edgelabel>&lt; int &gt;</edgelabel>
281        </childnode>
282      </node>
283      <node id="1380">
284        <label>DoubleUI</label>
285        <childnode refid="1379" relation="public-inheritance">
286        </childnode>
287      </node>
288      <node id="1376">
289        <label>TypedUserInfo&lt; T &gt;</label>
290        <link refid="classTypedUserInfo"/>
291        <childnode refid="1377" relation="public-inheritance">
292        </childnode>
293      </node>
294      <node id="1375">
295        <label>ValuedUserInfo&lt; T &gt;</label>
296        <link refid="classValuedUserInfo"/>
297        <childnode refid="1376" relation="public-inheritance">
298        </childnode>
299      </node>
300      <node id="1383">
301        <label>ValuedUserInfo&lt; string &gt;</label>
302        <link refid="classValuedUserInfo"/>
303        <childnode refid="1375" relation="template-instance">
304          <edgelabel>&lt; string &gt;</edgelabel>
305        </childnode>
306      </node>
307      <node id="1385">
308        <label>ValuedUserInfo&lt; bool &gt;</label>
309        <link refid="classValuedUserInfo"/>
310        <childnode refid="1375" relation="template-instance">
311          <edgelabel>&lt; bool &gt;</edgelabel>
312        </childnode>
313      </node>
314      <node id="1377">
315        <label>UserInfo</label>
316        <link refid="classUserInfo"/>
317        <childnode refid="1378" relation="protected-inheritance">
318        </childnode>
319      </node>
320      <node id="1379">
321        <label>ValuedUserInfo&lt; double &gt;</label>
322        <link refid="classValuedUserInfo"/>
323        <childnode refid="1375" relation="template-instance">
324          <edgelabel>&lt; double &gt;</edgelabel>
325        </childnode>
326      </node>
327      <node id="1386">
328        <label>BoolUI</label>
329        <childnode refid="1385" relation="public-inheritance">
330        </childnode>
331      </node>
332      <node id="1384">
333        <label>StringUI</label>
334        <childnode refid="1383" relation="public-inheritance">
335        </childnode>
336      </node>
337      <node id="1382">
338        <label>IntUI</label>
339        <childnode refid="1381" relation="public-inheritance">
340        </childnode>
341      </node>
342      <node id="1378">
343        <label>BindingFrame</label>
344        <link refid="classBindingFrame"/>
345      </node>
346    </inheritancegraph>
347    <collaborationgraph>
348      <node id="1391">
349        <label>AssertXercesIsAlive</label>
350        <link refid="classAssertXercesIsAlive"/>
351      </node>
352      <node id="1388">
353        <label>TypedUserInfo&lt; T &gt;</label>
354        <link refid="classTypedUserInfo"/>
355        <childnode refid="1389" relation="public-inheritance">
356        </childnode>
357      </node>
358      <node id="1392">
359        <label>string</label>
360      </node>
361      <node id="1387">
362        <label>ValuedUserInfo&lt; T &gt;</label>
363        <link refid="classValuedUserInfo"/>
364        <childnode refid="1388" relation="public-inheritance">
365        </childnode>
366        <childnode refid="1392" relation="usage">
367          <edgelabel>value</edgelabel>
368        </childnode>
369      </node>
370      <node id="1389">
371        <label>UserInfo</label>
372        <link refid="classUserInfo"/>
373        <childnode refid="1390" relation="protected-inheritance">
374        </childnode>
375        <childnode refid="1392" relation="usage">
376          <edgelabel>userFriendlyTypeName
377typeNameByRTTI</edgelabel>
378        </childnode>
379      </node>
380      <node id="1390">
381        <label>BindingFrame</label>
382        <link refid="classBindingFrame"/>
383        <childnode refid="1391" relation="usage">
384          <edgelabel>dummy</edgelabel>
385        </childnode>
386      </node>
387    </collaborationgraph>
388    <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="528" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="527" bodyend="553"/>
389    <listofallmembers>
390      <member refid="classUserInfo_10f090c6525a3e8fb11634a553f467ede" prot="public" virt="non-virtual"><scope>ValuedUserInfo</scope><name>Assembly</name></member>
391      <member refid="classValuedUserInfo_18d9c6bf7f1b043fcd8d3f375f49948e9" prot="private" virt="virtual"><scope>ValuedUserInfo</scope><name>AssemblyComponentsFromXML</name></member>
392      <member refid="classBindingFrame_165bec8fcde1865e2e211f42ca52a816f" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>BindingFrame</name></member>
393      <member refid="classUserInfo_11d402661b82feccb5265a70f65c242e1" prot="public" virt="non-virtual"><scope>ValuedUserInfo</scope><name>Disassembly</name></member>
394      <member refid="classUserInfo_1917b2257abc31b94c89ef3cd270e4a42" prot="public" virt="non-virtual"><scope>ValuedUserInfo</scope><name>Disassembly</name></member>
395      <member refid="classValuedUserInfo_18dbc439e17a251934160bc505bcaa4a4" prot="private" virt="virtual"><scope>ValuedUserInfo</scope><name>DisassemblyComponentsToXML</name></member>
396      <member refid="classTypedUserInfo_1c7ad10a9ff002383518155c965ade85c" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>instance</name></member>
397      <member refid="classBindingFrame_18d4dc5902ee71a473983d6a8fa3c8b7a" prot="protected" virt="virtual"><scope>ValuedUserInfo</scope><name>ReleaseMemory</name></member>
398      <member refid="classBindingFrame_1820e4df85c0dc545e3079e407fcdbbaa" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>removeSpaces</name></member>
399      <member refid="classTypedUserInfo_1f4fe0532c1cdee3d6e00d96561efbdd5" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>TypedUserInfo</name></member>
400      <member refid="classUserInfo_10bccb19c6b819cf9f763e985c573ae8f" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>UserInfo</name></member>
401      <member refid="classValuedUserInfo_110a0acb3696018386451881ebcc797ea" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>value</name></member>
402      <member refid="classValuedUserInfo_186897fcfe4666183bcecf16a23715cdb" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>ValuedUserInfo</name></member>
403      <member refid="classBindingFrame_12244bd5181c3d1e70f3a6be2b72e9424" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>XMLCh2str</name></member>
404      <member refid="classTypedUserInfo_1b1bb67b76a677f0cf33e923fd9147e9a" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>~TypedUserInfo</name></member>
405      <member refid="classValuedUserInfo_14c37684500f88a6d7d8d06b73ab5267a" prot="protected" virt="non-virtual"><scope>ValuedUserInfo</scope><name>~ValuedUserInfo</name></member>
406    </listofallmembers>
407  </compounddef>
408</doxygen>
Note: See TracBrowser for help on using the browser.