root/doc/xml/classStringUI.xml @ 267

Revision 187, 20.4 kB (checked in by smidl, 17 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="classStringUI" kind="class" prot="public">
4    <compoundname>StringUI</compoundname>
5    <basecompoundref refid="classValuedUserInfo" prot="public" virt="non-virtual">ValuedUserInfo&lt; string &gt;</basecompoundref>
6      <sectiondef kind="private-func">
7      <memberdef kind="function" id="classStringUI_16e55d5eaa5684496569a8e694aa5f15e" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
8        <type>string *</type>
9        <definition>string* StringUI::AssemblyInstance</definition>
10        <argsstring>()</argsstring>
11        <name>AssemblyInstance</name>
12        <briefdescription>
13        </briefdescription>
14        <detaileddescription>
15        </detaileddescription>
16        <inbodydescription>
17        </inbodydescription>
18        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="702" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="701" bodyend="704"/>
19      </memberdef>
20      <memberdef kind="function" id="classStringUI_1856c952ffccb40fa0429ca5420dbdba6" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
21        <type>bool</type>
22        <definition>bool StringUI::DisassemblyInstance</definition>
23        <argsstring>(string &amp;instance)</argsstring>
24        <name>DisassemblyInstance</name>
25        <param>
26          <type>string &amp;</type>
27          <declname>instance</declname>
28        </param>
29        <briefdescription>
30        </briefdescription>
31        <detaileddescription>
32        </detaileddescription>
33        <inbodydescription>
34        </inbodydescription>
35        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="707" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="706" bodyend="710"/>
36      </memberdef>
37      </sectiondef>
38      <sectiondef kind="public-func">
39      <memberdef kind="function" id="classStringUI_1b6d730a02a8717e132dbfeab957264e4" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
40        <type></type>
41        <definition>StringUI::StringUI</definition>
42        <argsstring>()</argsstring>
43        <name>StringUI</name>
44        <briefdescription>
45        </briefdescription>
46        <detaileddescription>
47        </detaileddescription>
48        <inbodydescription>
49        </inbodydescription>
50        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="714" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="713" bodyend="715"/>
51      </memberdef>
52      </sectiondef>
53      <sectiondef kind="protected-attrib">
54      <memberdef kind="variable" id="classValuedUserInfo_110a0acb3696018386451881ebcc797ea" prot="protected" static="no" mutable="no">
55        <type>string</type>
56        <definition>string ValuedUserInfo&lt; string  &gt;::value</definition>
57        <argsstring></argsstring>
58        <name>value</name>
59        <briefdescription>
60<para>string variable which is automatically binded to a proper DOMElement attribute </para>        </briefdescription>
61        <detaileddescription>
62        </detaileddescription>
63        <inbodydescription>
64        </inbodydescription>
65        <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"/>
66      </memberdef>
67      </sectiondef>
68      <sectiondef kind="protected-static-attrib">
69      <memberdef kind="variable" id="classTypedUserInfo_1c7ad10a9ff002383518155c965ade85c" prot="protected" static="yes" mutable="no">
70        <type>const <ref refid="classTypedUserInfo" kindref="compound">TypedUserInfo</ref>&lt; string &gt; &amp;</type>
71        <definition>const TypedUserInfo&lt; string &gt; &amp; TypedUserInfo&lt; string &gt;::instance</definition>
72        <argsstring></argsstring>
73        <name>instance</name>
74        <initializer> StringUI()</initializer>
75        <briefdescription>
76        </briefdescription>
77        <detaileddescription>
78<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>
79        <inbodydescription>
80        </inbodydescription>
81        <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"/>
82      </memberdef>
83      </sectiondef>
84      <sectiondef kind="public-static-func">
85      <memberdef kind="function" id="classUserInfo_10f090c6525a3e8fb11634a553f467ede" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
86        <templateparamlist>
87          <param>
88            <type>class</type>
89            <declname>T</declname>
90            <defname>T</defname>
91          </param>
92        </templateparamlist>
93        <type>T *</type>
94        <definition>static T* UserInfo::Assembly</definition>
95        <argsstring>(DOMElement &amp;element, const string tagName)</argsstring>
96        <name>Assembly</name>
97        <param>
98          <type>DOMElement &amp;</type>
99          <declname>element</declname>
100        </param>
101        <param>
102          <type>const string</type>
103          <declname>tagName</declname>
104        </param>
105        <briefdescription>
106        </briefdescription>
107        <detaileddescription>
108<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>
109        <inbodydescription>
110        </inbodydescription>
111        <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"/>
112        <references refid="classAttribute_16ebbcaaf9c90a979e645f469e02bb940" compoundref="userinfo_8cpp" startline="40" endline="44">Attribute::Get</references>
113        <references refid="classAttribute_15f6cce980606fa8943857204aacb5478" compoundref="userinfo_8h" startline="152">Attribute::type</references>
114      </memberdef>
115      <memberdef kind="function" id="classUserInfo_11d402661b82feccb5265a70f65c242e1" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
116        <templateparamlist>
117          <param>
118            <type>class</type>
119            <declname>T</declname>
120            <defname>T</defname>
121          </param>
122        </templateparamlist>
123        <type>bool</type>
124        <definition>static bool UserInfo::Disassembly</definition>
125        <argsstring>(T &amp;instance, DOMElement &amp;element, const string tagName, const string help)</argsstring>
126        <name>Disassembly</name>
127        <param>
128          <type>T &amp;</type>
129          <declname>instance</declname>
130        </param>
131        <param>
132          <type>DOMElement &amp;</type>
133          <declname>element</declname>
134        </param>
135        <param>
136          <type>const string</type>
137          <declname>tagName</declname>
138        </param>
139        <param>
140          <type>const string</type>
141          <declname>help</declname>
142        </param>
143        <briefdescription>
144        </briefdescription>
145        <detaileddescription>
146<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>
147        <inbodydescription>
148        </inbodydescription>
149        <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"/>
150        <references refid="classAttribute_1d6474fd976f505e70e10c497199c6770" compoundref="userinfo_8h" startline="149">Attribute::help</references>
151        <references refid="classAttribute_1e011d84e2e3c40390807a8b8e58e3c35" compoundref="userinfo_8cpp" startline="46" endline="52">Attribute::Set</references>
152        <references refid="classAttribute_15f6cce980606fa8943857204aacb5478" compoundref="userinfo_8h" startline="152">Attribute::type</references>
153        <referencedby refid="classUserInfo_1917b2257abc31b94c89ef3cd270e4a42" compoundref="userinfo_8h" startline="327" endline="330">UserInfo::Disassembly</referencedby>
154        <referencedby refid="classCompoundUserInfo_1_1BindedElement_16ef55cedb98f5d2dbcf92730f2fed939" compoundref="userinfo_8h" startline="479" endline="482">CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::DisassemblyComponentsToXML</referencedby>
155      </memberdef>
156      <memberdef kind="function" id="classUserInfo_1917b2257abc31b94c89ef3cd270e4a42" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
157        <templateparamlist>
158          <param>
159            <type>class</type>
160            <declname>T</declname>
161            <defname>T</defname>
162          </param>
163        </templateparamlist>
164        <type>bool</type>
165        <definition>static bool UserInfo::Disassembly</definition>
166        <argsstring>(T &amp;instance, DOMElement &amp;element, const string tagName)</argsstring>
167        <name>Disassembly</name>
168        <param>
169          <type>T &amp;</type>
170          <declname>instance</declname>
171        </param>
172        <param>
173          <type>DOMElement &amp;</type>
174          <declname>element</declname>
175        </param>
176        <param>
177          <type>const string</type>
178          <declname>tagName</declname>
179        </param>
180        <briefdescription>
181        </briefdescription>
182        <detaileddescription>
183<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>
184        <inbodydescription>
185        </inbodydescription>
186        <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"/>
187        <references refid="classUserInfo_11d402661b82feccb5265a70f65c242e1" compoundref="userinfo_8h" startline="297" endline="321">UserInfo::Disassembly</references>
188      </memberdef>
189      </sectiondef>
190      <sectiondef kind="protected-func">
191      <memberdef kind="function" id="classBindingFrame_12244bd5181c3d1e70f3a6be2b72e9424" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
192        <type>string</type>
193        <definition>string BindingFrame::XMLCh2str</definition>
194        <argsstring>(const XMLCh *const XMLCh_str)</argsstring>
195        <name>XMLCh2str</name>
196        <param>
197          <type>const XMLCh *const </type>
198          <declname>XMLCh_str</declname>
199        </param>
200        <briefdescription>
201<para>function which transcodes Xerces&apos; XMLCh-based strings into C++ strings </para>        </briefdescription>
202        <detaileddescription>
203        </detaileddescription>
204        <inbodydescription>
205        </inbodydescription>
206        <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"/>
207      </memberdef>
208      <memberdef kind="function" id="classBindingFrame_1820e4df85c0dc545e3079e407fcdbbaa" prot="protected" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
209        <type>string</type>
210        <definition>string BindingFrame::removeSpaces</definition>
211        <argsstring>(const string &amp;str)</argsstring>
212        <name>removeSpaces</name>
213        <param>
214          <type>const string &amp;</type>
215          <declname>str</declname>
216        </param>
217        <briefdescription>
218        </briefdescription>
219        <detaileddescription>
220        </detaileddescription>
221        <inbodydescription>
222        </inbodydescription>
223        <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"/>
224      </memberdef>
225      <memberdef kind="function" id="classBindingFrame_18d4dc5902ee71a473983d6a8fa3c8b7a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
226        <type>void</type>
227        <definition>virtual void BindingFrame::ReleaseMemory</definition>
228        <argsstring>()</argsstring>
229        <name>ReleaseMemory</name>
230        <reimplementedby refid="classCompoundUserInfo_1db347fdb53198e3a44ecdeddced6e273">ReleaseMemory</reimplementedby>
231        <reimplementedby refid="classCompoundUserInfo_1db347fdb53198e3a44ecdeddced6e273">ReleaseMemory</reimplementedby>
232        <reimplementedby refid="classCompoundUserInfo_1db347fdb53198e3a44ecdeddced6e273">ReleaseMemory</reimplementedby>
233        <reimplementedby refid="classCompoundUserInfo_1_1BindedElement_1e5a47de35cae44540b02d4c12fde54e4">ReleaseMemory</reimplementedby>
234        <briefdescription>
235<para>A method for releasing memory allocated within the &apos;AssemblyComponentsFromXML()&apos; method. </para>        </briefdescription>
236        <detaileddescription>
237        </detaileddescription>
238        <inbodydescription>
239        </inbodydescription>
240        <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"/>
241      </memberdef>
242      </sectiondef>
243    <briefdescription>
244    </briefdescription>
245    <detaileddescription>
246    </detaileddescription>
247    <inheritancegraph>
248      <node id="1302">
249        <label>TypedUserInfo&lt; T &gt;</label>
250        <link refid="classTypedUserInfo"/>
251        <childnode refid="1300" relation="public-inheritance">
252        </childnode>
253      </node>
254      <node id="1299">
255        <label>TypedUserInfo&lt; string &gt;</label>
256        <link refid="classTypedUserInfo"/>
257        <childnode refid="1300" relation="public-inheritance">
258        </childnode>
259        <childnode refid="1302" relation="template-instance">
260          <edgelabel>&lt; string &gt;</edgelabel>
261        </childnode>
262      </node>
263      <node id="1303">
264        <label>ValuedUserInfo&lt; T &gt;</label>
265        <link refid="classValuedUserInfo"/>
266        <childnode refid="1302" relation="public-inheritance">
267        </childnode>
268      </node>
269      <node id="1298">
270        <label>ValuedUserInfo&lt; string &gt;</label>
271        <link refid="classValuedUserInfo"/>
272        <childnode refid="1299" relation="public-inheritance">
273        </childnode>
274        <childnode refid="1303" relation="template-instance">
275          <edgelabel>&lt; string &gt;</edgelabel>
276        </childnode>
277      </node>
278      <node id="1300">
279        <label>UserInfo</label>
280        <link refid="classUserInfo"/>
281        <childnode refid="1301" relation="protected-inheritance">
282        </childnode>
283      </node>
284      <node id="1297">
285        <label>StringUI</label>
286        <childnode refid="1298" relation="public-inheritance">
287        </childnode>
288      </node>
289      <node id="1301">
290        <label>BindingFrame</label>
291        <link refid="classBindingFrame"/>
292      </node>
293    </inheritancegraph>
294    <collaborationgraph>
295      <node id="1309">
296        <label>AssertXercesIsAlive</label>
297        <link refid="classAssertXercesIsAlive"/>
298      </node>
299      <node id="1311">
300        <label>TypedUserInfo&lt; T &gt;</label>
301        <link refid="classTypedUserInfo"/>
302        <childnode refid="1307" relation="public-inheritance">
303        </childnode>
304      </node>
305      <node id="1306">
306        <label>TypedUserInfo&lt; string &gt;</label>
307        <link refid="classTypedUserInfo"/>
308        <childnode refid="1307" relation="public-inheritance">
309        </childnode>
310        <childnode refid="1306" relation="usage">
311          <edgelabel>instance</edgelabel>
312        </childnode>
313        <childnode refid="1311" relation="template-instance">
314          <edgelabel>&lt; string &gt;</edgelabel>
315        </childnode>
316      </node>
317      <node id="1310">
318        <label>string</label>
319      </node>
320      <node id="1312">
321        <label>ValuedUserInfo&lt; T &gt;</label>
322        <link refid="classValuedUserInfo"/>
323        <childnode refid="1311" relation="public-inheritance">
324        </childnode>
325        <childnode refid="1310" relation="usage">
326          <edgelabel>value</edgelabel>
327        </childnode>
328      </node>
329      <node id="1305">
330        <label>ValuedUserInfo&lt; string &gt;</label>
331        <link refid="classValuedUserInfo"/>
332        <childnode refid="1306" relation="public-inheritance">
333        </childnode>
334        <childnode refid="1310" relation="usage">
335          <edgelabel>value</edgelabel>
336        </childnode>
337        <childnode refid="1312" relation="template-instance">
338          <edgelabel>&lt; string &gt;</edgelabel>
339        </childnode>
340      </node>
341      <node id="1307">
342        <label>UserInfo</label>
343        <link refid="classUserInfo"/>
344        <childnode refid="1308" relation="protected-inheritance">
345        </childnode>
346        <childnode refid="1310" relation="usage">
347          <edgelabel>userFriendlyTypeName
348typeNameByRTTI</edgelabel>
349        </childnode>
350      </node>
351      <node id="1304">
352        <label>StringUI</label>
353        <childnode refid="1305" relation="public-inheritance">
354        </childnode>
355      </node>
356      <node id="1308">
357        <label>BindingFrame</label>
358        <link refid="classBindingFrame"/>
359        <childnode refid="1309" relation="usage">
360          <edgelabel>dummy</edgelabel>
361        </childnode>
362      </node>
363    </collaborationgraph>
364    <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="699" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="698" bodyend="716"/>
365    <listofallmembers>
366      <member refid="classUserInfo_10f090c6525a3e8fb11634a553f467ede" prot="public" virt="non-virtual"><scope>StringUI</scope><name>Assembly</name></member>
367      <member refid="classStringUI_16e55d5eaa5684496569a8e694aa5f15e" prot="private" virt="non-virtual"><scope>StringUI</scope><name>AssemblyInstance</name></member>
368      <member refid="classBindingFrame_165bec8fcde1865e2e211f42ca52a816f" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>BindingFrame</name></member>
369      <member refid="classUserInfo_11d402661b82feccb5265a70f65c242e1" prot="public" virt="non-virtual"><scope>StringUI</scope><name>Disassembly</name></member>
370      <member refid="classUserInfo_1917b2257abc31b94c89ef3cd270e4a42" prot="public" virt="non-virtual"><scope>StringUI</scope><name>Disassembly</name></member>
371      <member refid="classStringUI_1856c952ffccb40fa0429ca5420dbdba6" prot="private" virt="non-virtual"><scope>StringUI</scope><name>DisassemblyInstance</name></member>
372      <member refid="classTypedUserInfo_1c7ad10a9ff002383518155c965ade85c" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>instance</name></member>
373      <member refid="classBindingFrame_18d4dc5902ee71a473983d6a8fa3c8b7a" prot="protected" virt="virtual"><scope>StringUI</scope><name>ReleaseMemory</name></member>
374      <member refid="classBindingFrame_1820e4df85c0dc545e3079e407fcdbbaa" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>removeSpaces</name></member>
375      <member refid="classStringUI_1b6d730a02a8717e132dbfeab957264e4" prot="public" virt="non-virtual"><scope>StringUI</scope><name>StringUI</name></member>
376      <member refid="classTypedUserInfo_1f4fe0532c1cdee3d6e00d96561efbdd5" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>TypedUserInfo</name></member>
377      <member refid="classUserInfo_10bccb19c6b819cf9f763e985c573ae8f" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>UserInfo</name></member>
378      <member refid="classValuedUserInfo_110a0acb3696018386451881ebcc797ea" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>value</name></member>
379      <member refid="classValuedUserInfo_186897fcfe4666183bcecf16a23715cdb" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>ValuedUserInfo</name></member>
380      <member refid="classBindingFrame_12244bd5181c3d1e70f3a6be2b72e9424" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>XMLCh2str</name></member>
381      <member refid="classTypedUserInfo_1b1bb67b76a677f0cf33e923fd9147e9a" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>~TypedUserInfo</name></member>
382      <member refid="classValuedUserInfo_14c37684500f88a6d7d8d06b73ab5267a" prot="protected" virt="non-virtual"><scope>StringUI</scope><name>~ValuedUserInfo</name></member>
383    </listofallmembers>
384  </compounddef>
385</doxygen>
Note: See TracBrowser for help on using the browser.