root/doc/xml/classBikeUI.xml @ 187

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