root/doc/xml/classCompoundUserInfo_1_1BindedElement.xml @ 267

Revision 187, 17.8 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="classCompoundUserInfo_1_1BindedElement" kind="class" prot="protected">
4    <compoundname>CompoundUserInfo::BindedElement</compoundname>
5    <basecompoundref refid="classBindingFrame" prot="public" virt="non-virtual">BindingFrame</basecompoundref>
6    <includes refid="userinfo_8h" local="no">userinfo.h</includes>
7    <templateparamlist>
8      <param>
9        <type>typename</type>
10        <declname>U</declname>
11        <defname>U</defname>
12      </param>
13    </templateparamlist>
14      <sectiondef kind="private-attrib">
15      <memberdef kind="variable" id="classCompoundUserInfo_1_1BindedElement_13c2e7a83c27314e2511794277a6539ed" prot="private" static="no" mutable="no">
16        <type>string</type>
17        <definition>string CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::name</definition>
18        <argsstring></argsstring>
19        <name>name</name>
20        <briefdescription>
21        </briefdescription>
22        <detaileddescription>
23        </detaileddescription>
24        <inbodydescription>
25        </inbodydescription>
26        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="435" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="435" bodyend="-1"/>
27      </memberdef>
28      <memberdef kind="variable" id="classCompoundUserInfo_1_1BindedElement_1be6ef1e32e710805253360effd7aa624" prot="private" static="no" mutable="no">
29        <type>string</type>
30        <definition>string CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::help</definition>
31        <argsstring></argsstring>
32        <name>help</name>
33        <briefdescription>
34        </briefdescription>
35        <detaileddescription>
36        </detaileddescription>
37        <inbodydescription>
38        </inbodydescription>
39        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="436" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="436" bodyend="-1"/>
40      </memberdef>
41      <memberdef kind="variable" id="classCompoundUserInfo_1_1BindedElement_123749052b6d19096198c87ac592a9e9d" prot="private" static="no" mutable="no">
42        <type>bool</type>
43        <definition>bool CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::release</definition>
44        <argsstring></argsstring>
45        <name>release</name>
46        <briefdescription>
47        </briefdescription>
48        <detaileddescription>
49        </detaileddescription>
50        <inbodydescription>
51        </inbodydescription>
52        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="437" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="437" bodyend="-1"/>
53      </memberdef>
54      <memberdef kind="variable" id="classCompoundUserInfo_1_1BindedElement_1ddbf81c9401e3a848a3154d0481d84af" prot="private" static="no" mutable="no">
55        <type>U *</type>
56        <definition>U* CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::pValue</definition>
57        <argsstring></argsstring>
58        <name>pValue</name>
59        <briefdescription>
60        </briefdescription>
61        <detaileddescription>
62        </detaileddescription>
63        <inbodydescription>
64        </inbodydescription>
65        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="439" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="439" bodyend="-1"/>
66      </memberdef>
67      <memberdef kind="variable" id="classCompoundUserInfo_1_1BindedElement_156acf1ea9e77d06c1bfa54e665d87121" prot="private" static="no" mutable="no">
68        <type>const U</type>
69        <definition>const U CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::defaultValue</definition>
70        <argsstring></argsstring>
71        <name>defaultValue</name>
72        <briefdescription>
73        </briefdescription>
74        <detaileddescription>
75        </detaileddescription>
76        <inbodydescription>
77        </inbodydescription>
78        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="441" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="441" bodyend="-1"/>
79      </memberdef>
80      </sectiondef>
81      <sectiondef kind="public-attrib">
82      <memberdef kind="variable" id="classCompoundUserInfo_1_1BindedElement_159b12f92976b591c04c786637b62e24a" prot="public" static="no" mutable="no">
83        <type>U</type>
84        <definition>U CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::value</definition>
85        <argsstring></argsstring>
86        <name>value</name>
87        <briefdescription>
88        </briefdescription>
89        <detaileddescription>
90        </detaileddescription>
91        <inbodydescription>
92        </inbodydescription>
93        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="445" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="445" bodyend="-1"/>
94      </memberdef>
95      </sectiondef>
96      <sectiondef kind="public-func">
97      <memberdef kind="function" id="classCompoundUserInfo_1_1BindedElement_17edaf564489a009ea604205a8f2641a1" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
98        <type></type>
99        <definition>CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::BindedElement</definition>
100        <argsstring>(CompoundUserInfo&lt; T &gt; *parent, string name, U defaultValue, string help)</argsstring>
101        <name>BindedElement</name>
102        <param>
103          <type><ref refid="classCompoundUserInfo" kindref="compound">CompoundUserInfo</ref>&lt; T &gt; *</type>
104          <declname>parent</declname>
105        </param>
106        <param>
107          <type>string</type>
108          <declname>name</declname>
109        </param>
110        <param>
111          <type>U</type>
112          <declname>defaultValue</declname>
113        </param>
114        <param>
115          <type>string</type>
116          <declname>help</declname>
117        </param>
118        <briefdescription>
119        </briefdescription>
120        <detaileddescription>
121        </detaileddescription>
122        <inbodydescription>
123        </inbodydescription>
124        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="449"/>
125      </memberdef>
126      <memberdef kind="function" id="classCompoundUserInfo_1_1BindedElement_1b6a90093acc730505ba6ed3d61e10e9b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
127        <type></type>
128        <definition>CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::BindedElement</definition>
129        <argsstring>(CompoundUserInfo&lt; T &gt; *parent, string name, U defaultValue)</argsstring>
130        <name>BindedElement</name>
131        <param>
132          <type><ref refid="classCompoundUserInfo" kindref="compound">CompoundUserInfo</ref>&lt; T &gt; *</type>
133          <declname>parent</declname>
134        </param>
135        <param>
136          <type>string</type>
137          <declname>name</declname>
138        </param>
139        <param>
140          <type>U</type>
141          <declname>defaultValue</declname>
142        </param>
143        <briefdescription>
144        </briefdescription>
145        <detaileddescription>
146        </detaileddescription>
147        <inbodydescription>
148        </inbodydescription>
149        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="457"/>
150      </memberdef>
151      <memberdef kind="function" id="classCompoundUserInfo_1_1BindedElement_1dd7cb5c77c7f3eccec78a5dbcdc23364" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
152        <type></type>
153        <definition>CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::~BindedElement</definition>
154        <argsstring>()</argsstring>
155        <name>~BindedElement</name>
156        <briefdescription>
157        </briefdescription>
158        <detaileddescription>
159        </detaileddescription>
160        <inbodydescription>
161        </inbodydescription>
162        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="464"/>
163      </memberdef>
164      <memberdef kind="function" id="classCompoundUserInfo_1_1BindedElement_1159f56d7101091117dcdad68754bc195" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
165        <type>void</type>
166        <definition>void CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::AssemblyComponentsFromXML</definition>
167        <argsstring>(DOMElement &amp;element)</argsstring>
168        <name>AssemblyComponentsFromXML</name>
169        <reimplements refid="classBindingFrame_1c6d068c261d4fc3a0a4d1305ade1483d">AssemblyComponentsFromXML</reimplements>
170        <param>
171          <type>DOMElement &amp;</type>
172          <declname>element</declname>
173        </param>
174        <briefdescription>
175<para>This method parse DOMElement, finds proper DOMNode and fills binded data accordingly. </para>        </briefdescription>
176        <detaileddescription>
177        </detaileddescription>
178        <inbodydescription>
179        </inbodydescription>
180        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="468" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="467" bodyend="471"/>
181      </memberdef>
182      <memberdef kind="function" id="classCompoundUserInfo_1_1BindedElement_1e5a47de35cae44540b02d4c12fde54e4" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
183        <type>void</type>
184        <definition>void CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::ReleaseMemory</definition>
185        <argsstring>()</argsstring>
186        <name>ReleaseMemory</name>
187        <reimplements refid="classBindingFrame_18d4dc5902ee71a473983d6a8fa3c8b7a">ReleaseMemory</reimplements>
188        <briefdescription>
189<para>A method for releasing memory allocated within the &apos;AssemblyComponentsFromXML()&apos; method. </para>        </briefdescription>
190        <detaileddescription>
191        </detaileddescription>
192        <inbodydescription>
193        </inbodydescription>
194        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="474" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="473" bodyend="477"/>
195      </memberdef>
196      <memberdef kind="function" id="classCompoundUserInfo_1_1BindedElement_16ef55cedb98f5d2dbcf92730f2fed939" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
197        <type>bool</type>
198        <definition>bool CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;::DisassemblyComponentsToXML</definition>
199        <argsstring>(DOMElement &amp;element)</argsstring>
200        <name>DisassemblyComponentsToXML</name>
201        <reimplements refid="classBindingFrame_10c207ed6e5a4c975ed5bc9a758a063ca">DisassemblyComponentsToXML</reimplements>
202        <param>
203          <type>DOMElement &amp;</type>
204          <declname>element</declname>
205        </param>
206        <briefdescription>
207        </briefdescription>
208        <detaileddescription>
209<para>This method reads binded data, fill them into a new DOMNode, which then appends to the passed DOMElement </para>        </detaileddescription>
210        <inbodydescription>
211        </inbodydescription>
212        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="480" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="479" bodyend="482"/>
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<para>Templated class binding inner element with its XML tag and automating data transfers in both directions. </para>    </briefdescription>
254    <detaileddescription>
255    </detaileddescription>
256    <inheritancegraph>
257      <node id="781">
258        <label>CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;</label>
259        <link refid="classCompoundUserInfo_1_1BindedElement"/>
260        <childnode refid="782" relation="public-inheritance">
261        </childnode>
262      </node>
263      <node id="782">
264        <label>BindingFrame</label>
265        <link refid="classBindingFrame"/>
266      </node>
267    </inheritancegraph>
268    <collaborationgraph>
269      <node id="786">
270        <label>U</label>
271      </node>
272      <node id="785">
273        <label>AssertXercesIsAlive</label>
274        <link refid="classAssertXercesIsAlive"/>
275      </node>
276      <node id="787">
277        <label>string</label>
278      </node>
279      <node id="783">
280        <label>CompoundUserInfo&lt; T &gt;::BindedElement&lt; U &gt;</label>
281        <link refid="classCompoundUserInfo_1_1BindedElement"/>
282        <childnode refid="784" relation="public-inheritance">
283        </childnode>
284        <childnode refid="786" relation="usage">
285          <edgelabel>pValue
286defaultValue
287value</edgelabel>
288        </childnode>
289        <childnode refid="787" relation="usage">
290          <edgelabel>help
291name</edgelabel>
292        </childnode>
293      </node>
294      <node id="784">
295        <label>BindingFrame</label>
296        <link refid="classBindingFrame"/>
297        <childnode refid="785" relation="usage">
298          <edgelabel>dummy</edgelabel>
299        </childnode>
300      </node>
301    </collaborationgraph>
302    <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="433" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="432" bodyend="483"/>
303    <listofallmembers>
304      <member refid="classCompoundUserInfo_1_1BindedElement_1159f56d7101091117dcdad68754bc195" prot="public" virt="virtual"><scope>CompoundUserInfo::BindedElement</scope><name>AssemblyComponentsFromXML</name></member>
305      <member refid="classCompoundUserInfo_1_1BindedElement_17edaf564489a009ea604205a8f2641a1" prot="public" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>BindedElement</name></member>
306      <member refid="classCompoundUserInfo_1_1BindedElement_1b6a90093acc730505ba6ed3d61e10e9b" prot="public" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>BindedElement</name></member>
307      <member refid="classBindingFrame_165bec8fcde1865e2e211f42ca52a816f" prot="protected" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>BindingFrame</name></member>
308      <member refid="classCompoundUserInfo_1_1BindedElement_156acf1ea9e77d06c1bfa54e665d87121" prot="private" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>defaultValue</name></member>
309      <member refid="classCompoundUserInfo_1_1BindedElement_16ef55cedb98f5d2dbcf92730f2fed939" prot="public" virt="virtual"><scope>CompoundUserInfo::BindedElement</scope><name>DisassemblyComponentsToXML</name></member>
310      <member refid="classCompoundUserInfo_1_1BindedElement_1be6ef1e32e710805253360effd7aa624" prot="private" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>help</name></member>
311      <member refid="classCompoundUserInfo_1_1BindedElement_13c2e7a83c27314e2511794277a6539ed" prot="private" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>name</name></member>
312      <member refid="classCompoundUserInfo_1_1BindedElement_1ddbf81c9401e3a848a3154d0481d84af" prot="private" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>pValue</name></member>
313      <member refid="classCompoundUserInfo_1_1BindedElement_123749052b6d19096198c87ac592a9e9d" prot="private" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>release</name></member>
314      <member refid="classCompoundUserInfo_1_1BindedElement_1e5a47de35cae44540b02d4c12fde54e4" prot="public" virt="virtual"><scope>CompoundUserInfo::BindedElement</scope><name>ReleaseMemory</name></member>
315      <member refid="classBindingFrame_1820e4df85c0dc545e3079e407fcdbbaa" prot="protected" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>removeSpaces</name></member>
316      <member refid="classCompoundUserInfo_1_1BindedElement_159b12f92976b591c04c786637b62e24a" prot="public" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>value</name></member>
317      <member refid="classBindingFrame_12244bd5181c3d1e70f3a6be2b72e9424" prot="protected" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>XMLCh2str</name></member>
318      <member refid="classCompoundUserInfo_1_1BindedElement_1dd7cb5c77c7f3eccec78a5dbcdc23364" prot="public" virt="non-virtual"><scope>CompoundUserInfo::BindedElement</scope><name>~BindedElement</name></member>
319    </listofallmembers>
320  </compounddef>
321</doxygen>
Note: See TracBrowser for help on using the browser.