root/doc/xml/classEngineUI.xml @ 267

Revision 187, 18.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="classEngineUI" kind="class" prot="public">
4    <compoundname>EngineUI</compoundname>
5    <basecompoundref refid="classUserInfo" prot="public" virt="non-virtual">UserInfo&lt; Engine &gt;</basecompoundref>
6      <sectiondef kind="public-attrib">
7      <memberdef kind="variable" id="classEngineUI_1460f39281a1aa18d6d13fa5106121643" prot="public" static="no" mutable="no">
8        <type><ref refid="classStringAttribute" kindref="compound">StringAttribute</ref></type>
9        <definition>StringAttribute EngineUI::producer</definition>
10        <argsstring></argsstring>
11        <name>producer</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="20" bodyfile="/home/smidl/work/git/mixpp/tests/testUI.cpp" bodystart="20" bodyend="-1"/>
19      </memberdef>
20      <memberdef kind="variable" id="classEngineUI_1d045de5c74b161e9a0dafbeb5e1c66de" prot="public" static="no" mutable="no">
21        <type><ref refid="classDoubleAttribute" kindref="compound">DoubleAttribute</ref></type>
22        <definition>DoubleAttribute EngineUI::consumption</definition>
23        <argsstring></argsstring>
24        <name>consumption</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="21" bodyfile="/home/smidl/work/git/mixpp/tests/testUI.cpp" bodystart="21" bodyend="-1"/>
32      </memberdef>
33      <memberdef kind="variable" id="classUserInfo_1b63907af7cfccefeab209f8381962092" prot="public" static="no" mutable="no">
34        <type><ref refid="classStringAttribute" kindref="compound">StringAttribute</ref></type>
35        <definition>StringAttribute UserInfo&lt; Engine  &gt;::help</definition>
36        <argsstring></argsstring>
37        <name>help</name>
38        <briefdescription>
39<para>Explanation for an user is the only obligatory attribute. </para>        </briefdescription>
40        <detaileddescription>
41        </detaileddescription>
42        <inbodydescription>
43        </inbodydescription>
44        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="172" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="172" bodyend="-1"/>
45      </memberdef>
46      </sectiondef>
47      <sectiondef kind="public-func">
48      <memberdef kind="function" id="classEngineUI_1ce4d4902c24f34fc5ca17545a4a0ff83" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
49        <type></type>
50        <definition>EngineUI::EngineUI</definition>
51        <argsstring>()</argsstring>
52        <name>EngineUI</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="27" bodyfile="/home/smidl/work/git/mixpp/tests/testUI.cpp" bodystart="23" bodyend="30"/>
60      </memberdef>
61      <memberdef kind="function" id="classEngineUI_1ba55eba106280ea1ae26b0a93df101e1" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
62        <type>Engine *</type>
63        <definition>Engine* EngineUI::build</definition>
64        <argsstring>()</argsstring>
65        <name>build</name>
66        <reimplements refid="classUserInfo_1a7cab74e8214a87e5f226e9e88ff3d61">build</reimplements>
67        <briefdescription>
68<para>returns object of templated type filled with data stored in this <ref refid="classUserInfo" kindref="compound">UserInfo</ref> instance </para>        </briefdescription>
69        <detaileddescription>
70        </detaileddescription>
71        <inbodydescription>
72        </inbodydescription>
73        <location file="/home/smidl/work/git/mixpp/tests/testUI.cpp" line="33" bodyfile="/home/smidl/work/git/mixpp/tests/testUI.cpp" bodystart="32" bodyend="35"/>
74        <references refid="classDoubleAttribute_10ba8ddbd7fc2c6054159e695077ea6a2" compoundref="userinfo_8h" startline="102">DoubleAttribute::value</references>
75        <references refid="classStringAttribute_1e55ae245a8ae9e16236695bd5121f744" compoundref="userinfo_8h" startline="127">StringAttribute::value</references>
76        <referencedby refid="classCarUI_1931b042d42e04cb6ac84ee2a28d8ca3c" compoundref="testUI_8cpp" startline="74" endline="78">CarUI::build</referencedby>
77      </memberdef>
78      <memberdef kind="function" id="classUserInfo_1089b8a3ad514b17ae564a27328655126" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
79        <type>void</type>
80        <definition>void UserInfo&lt; Engine  &gt;::Save</definition>
81        <argsstring>(char *fileName)</argsstring>
82        <name>Save</name>
83        <param>
84          <type>char *</type>
85          <declname>fileName</declname>
86        </param>
87        <briefdescription>
88<para>Save <ref refid="classUserInfo" kindref="compound">UserInfo</ref> to the file (typically with an XML extension). </para>        </briefdescription>
89        <detaileddescription>
90        </detaileddescription>
91        <inbodydescription>
92        </inbodydescription>
93        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="196" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="195" bodyend="210"/>
94        <references refid="classUserInfo_122ca1ef5a10740e4107cd5a7e9a72856" compoundref="userinfo_8h" startline="292" endline="304">UserInfo&lt; T &gt;::FillElement</references>
95        <references refid="classGlobalXercesConnector_18d2d2a3f1b2a21a9647f7bc4c7e82c73" compoundref="userinfo_8h" startline="36">GlobalXercesConnector::pImplementation</references>
96        <references refid="classGlobalXercesConnector_1c6c620829e2a2fface1bea202b0608a6" compoundref="userinfo_8h" startline="38">GlobalXercesConnector::pSerializer</references>
97      </memberdef>
98      <memberdef kind="function" id="classUserInfo_1920c54d79132041a520180d083a6c503" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
99        <type>void</type>
100        <definition>void UserInfo&lt; Engine  &gt;::Load</definition>
101        <argsstring>(char *fileName)</argsstring>
102        <name>Load</name>
103        <param>
104          <type>char *</type>
105          <declname>fileName</declname>
106        </param>
107        <briefdescription>
108<para>Load <ref refid="classUserInfo" kindref="compound">UserInfo</ref> from the file (typically with an XML extension). </para>        </briefdescription>
109        <detaileddescription>
110        </detaileddescription>
111        <inbodydescription>
112        </inbodydescription>
113        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="213" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="212" bodyend="248"/>
114        <references refid="classUserInfo_1f673ea7ee23cc87e89d1530f94817800" compoundref="userinfo_8h" startline="256" endline="290">UserInfo&lt; T &gt;::ParseElement</references>
115        <references refid="classGlobalXercesConnector_1ca92055e0f5a5ea3d8cb1c4d6bf0dd51" compoundref="userinfo_8h" startline="40">GlobalXercesConnector::pParser</references>
116      </memberdef>
117      <memberdef kind="function" id="classUserInfo_151c1823208b719eec546b98bb855e272" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
118        <type>void</type>
119        <definition>void UserInfo&lt; Engine  &gt;::Attach</definition>
120        <argsstring>(MappedElements &amp;externalElements)</argsstring>
121        <name>Attach</name>
122        <param>
123          <type>MappedElements &amp;</type>
124          <declname>externalElements</declname>
125        </param>
126        <briefdescription>
127<para>This method is the key method to connect the element to its parent UI element. </para>        </briefdescription>
128        <detaileddescription>
129        </detaileddescription>
130        <inbodydescription>
131        </inbodydescription>
132        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="251" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="250" bodyend="254"/>
133      </memberdef>
134      <memberdef kind="function" id="classUserInfo_1f673ea7ee23cc87e89d1530f94817800" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
135        <type>void</type>
136        <definition>void UserInfo&lt; Engine  &gt;::ParseElement</definition>
137        <argsstring>(DOMElement *element)</argsstring>
138        <name>ParseElement</name>
139        <reimplements refid="classUserInfoCore_1a09a9b965ca04a186143787c0d049a7f">ParseElement</reimplements>
140        <param>
141          <type>DOMElement *</type>
142          <declname>element</declname>
143        </param>
144        <briefdescription>
145<para>Fills internal attributes and descendant elements according DOMElement. </para>        </briefdescription>
146        <detaileddescription>
147        </detaileddescription>
148        <inbodydescription>
149        </inbodydescription>
150        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="257" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="256" bodyend="290"/>
151        <references refid="classUserInfo_1aa6753c220a54aba613bfa3cc115d1c8" compoundref="userinfo_8h" startline="168">UserInfo&lt; T &gt;::attributes</references>
152        <references refid="classUserInfo_120783b9cdbef32b584be96851a8f9862" compoundref="userinfo_8h" startline="166">UserInfo&lt; T &gt;::elements</references>
153        <references refid="classGlobalXercesConnector_19800b81014bc6497815e28ad4bd3cf3a" compoundref="userinfo_8cpp" startline="45" endline="51">GlobalXercesConnector::XMLCh2str</references>
154      </memberdef>
155      <memberdef kind="function" id="classUserInfo_122ca1ef5a10740e4107cd5a7e9a72856" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
156        <type>void</type>
157        <definition>void UserInfo&lt; Engine  &gt;::FillElement</definition>
158        <argsstring>(DOMElement &amp;element)</argsstring>
159        <name>FillElement</name>
160        <reimplements refid="classUserInfoCore_1282c9bfd140bd09777aff395158c35ab">FillElement</reimplements>
161        <param>
162          <type>DOMElement &amp;</type>
163          <declname>element</declname>
164        </param>
165        <briefdescription>
166<para>Fills DOMElement according internal attributes and descendant elements. </para>        </briefdescription>
167        <detaileddescription>
168        </detaileddescription>
169        <inbodydescription>
170        </inbodydescription>
171        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="293" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="292" bodyend="304"/>
172        <references refid="classUserInfo_1aa6753c220a54aba613bfa3cc115d1c8" compoundref="userinfo_8h" startline="168">UserInfo&lt; T &gt;::attributes</references>
173        <references refid="classUserInfo_120783b9cdbef32b584be96851a8f9862" compoundref="userinfo_8h" startline="166">UserInfo&lt; T &gt;::elements</references>
174      </memberdef>
175      </sectiondef>
176      <sectiondef kind="protected-attrib">
177      <memberdef kind="variable" id="classUserInfo_120783b9cdbef32b584be96851a8f9862" prot="protected" static="no" mutable="no">
178        <type>MappedElements</type>
179        <definition>MappedElements UserInfo&lt; Engine  &gt;::elements</definition>
180        <argsstring></argsstring>
181        <name>elements</name>
182        <briefdescription>
183<para>MappiLength of the output vector. </para>        </briefdescription>
184        <detaileddescription>
185        </detaileddescription>
186        <inbodydescription>
187        </inbodydescription>
188        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="166" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="166" bodyend="-1"/>
189      </memberdef>
190      <memberdef kind="variable" id="classUserInfo_1aa6753c220a54aba613bfa3cc115d1c8" prot="protected" static="no" mutable="no">
191        <type><ref refid="classAttribute_1342750acf29e4c37d009301ef5075111" kindref="member">Attribute::MappedAttributes</ref></type>
192        <definition>Attribute::MappedAttributes UserInfo&lt; Engine  &gt;::attributes</definition>
193        <argsstring></argsstring>
194        <name>attributes</name>
195        <briefdescription>
196<para>Length of the output vector. </para>        </briefdescription>
197        <detaileddescription>
198        </detaileddescription>
199        <inbodydescription>
200        </inbodydescription>
201        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="168" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="168" bodyend="-1"/>
202      </memberdef>
203      </sectiondef>
204    <briefdescription>
205<para>User info for strings. </para>    </briefdescription>
206    <detaileddescription>
207    </detaileddescription>
208    <inheritancegraph>
209      <node id="833">
210        <label>UserInfoCore</label>
211        <link refid="classUserInfoCore"/>
212      </node>
213      <node id="831">
214        <label>EngineUI</label>
215        <link refid="classEngineUI"/>
216        <childnode refid="832" relation="public-inheritance">
217        </childnode>
218      </node>
219      <node id="834">
220        <label>UserInfo&lt; T &gt;</label>
221        <link refid="classUserInfo"/>
222        <childnode refid="833" relation="public-inheritance">
223        </childnode>
224      </node>
225      <node id="832">
226        <label>UserInfo&lt; Engine &gt;</label>
227        <link refid="classUserInfo"/>
228        <childnode refid="833" relation="public-inheritance">
229        </childnode>
230        <childnode refid="834" relation="template-instance">
231          <edgelabel>&lt; Engine &gt;</edgelabel>
232        </childnode>
233      </node>
234    </inheritancegraph>
235    <collaborationgraph>
236      <node id="837">
237        <label>UserInfoCore</label>
238        <link refid="classUserInfoCore"/>
239      </node>
240      <node id="839">
241        <label>Attribute</label>
242        <link refid="classAttribute"/>
243      </node>
244      <node id="835">
245        <label>EngineUI</label>
246        <link refid="classEngineUI"/>
247        <childnode refid="836" relation="public-inheritance">
248        </childnode>
249        <childnode refid="842" relation="usage">
250          <edgelabel>consumption</edgelabel>
251        </childnode>
252        <childnode refid="838" relation="usage">
253          <edgelabel>producer</edgelabel>
254        </childnode>
255      </node>
256      <node id="840">
257        <label>string</label>
258      </node>
259      <node id="838">
260        <label>StringAttribute</label>
261        <link refid="classStringAttribute"/>
262        <childnode refid="839" relation="public-inheritance">
263        </childnode>
264        <childnode refid="840" relation="usage">
265          <edgelabel>value</edgelabel>
266        </childnode>
267      </node>
268      <node id="841">
269        <label>UserInfo&lt; T &gt;</label>
270        <link refid="classUserInfo"/>
271        <childnode refid="837" relation="public-inheritance">
272        </childnode>
273        <childnode refid="838" relation="usage">
274          <edgelabel>help</edgelabel>
275        </childnode>
276      </node>
277      <node id="842">
278        <label>DoubleAttribute</label>
279        <link refid="classDoubleAttribute"/>
280        <childnode refid="839" relation="public-inheritance">
281        </childnode>
282      </node>
283      <node id="836">
284        <label>UserInfo&lt; Engine &gt;</label>
285        <link refid="classUserInfo"/>
286        <childnode refid="837" relation="public-inheritance">
287        </childnode>
288        <childnode refid="838" relation="usage">
289          <edgelabel>help</edgelabel>
290        </childnode>
291        <childnode refid="841" relation="template-instance">
292          <edgelabel>&lt; Engine &gt;</edgelabel>
293        </childnode>
294      </node>
295    </collaborationgraph>
296    <location file="/home/smidl/work/git/mixpp/tests/testUI.cpp" line="18" bodyfile="/home/smidl/work/git/mixpp/tests/testUI.cpp" bodystart="17" bodyend="36"/>
297    <listofallmembers>
298      <member refid="classUserInfo_151c1823208b719eec546b98bb855e272" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>Attach</name></member>
299      <member refid="classUserInfo_1aa6753c220a54aba613bfa3cc115d1c8" prot="protected" virt="non-virtual"><scope>EngineUI</scope><name>attributes</name></member>
300      <member refid="classEngineUI_1ba55eba106280ea1ae26b0a93df101e1" prot="public" virt="virtual"><scope>EngineUI</scope><name>build</name></member>
301      <member refid="classEngineUI_1d045de5c74b161e9a0dafbeb5e1c66de" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>consumption</name></member>
302      <member refid="classUserInfo_120783b9cdbef32b584be96851a8f9862" prot="protected" virt="non-virtual"><scope>EngineUI</scope><name>elements</name></member>
303      <member refid="classEngineUI_1ce4d4902c24f34fc5ca17545a4a0ff83" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>EngineUI</name></member>
304      <member refid="classUserInfo_122ca1ef5a10740e4107cd5a7e9a72856" prot="public" virt="virtual"><scope>EngineUI</scope><name>FillElement</name></member>
305      <member refid="classUserInfo_1b63907af7cfccefeab209f8381962092" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>help</name></member>
306      <member refid="classUserInfo_1920c54d79132041a520180d083a6c503" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>Load</name></member>
307      <member refid="classUserInfo_1f673ea7ee23cc87e89d1530f94817800" prot="public" virt="virtual"><scope>EngineUI</scope><name>ParseElement</name></member>
308      <member refid="classEngineUI_1460f39281a1aa18d6d13fa5106121643" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>producer</name></member>
309      <member refid="classUserInfo_1089b8a3ad514b17ae564a27328655126" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>Save</name></member>
310      <member refid="classUserInfo_115450d05eb4ac5f57c03d3c0707837e1" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>UserInfo</name></member>
311      <member refid="classUserInfo_17583dc01223fcd3dfb2a97d80efe4565" prot="public" virt="non-virtual"><scope>EngineUI</scope><name>~UserInfo</name></member>
312    </listofallmembers>
313  </compounddef>
314</doxygen>
Note: See TracBrowser for help on using the browser.