root/doc/xml/classAttribute.xml @ 187

Revision 187, 11.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="classAttribute" kind="class" prot="public">
4    <compoundname>Attribute</compoundname>
5    <includes refid="userinfo_8h" local="no">userinfo.h</includes>
6      <sectiondef kind="private-attrib">
7      <memberdef kind="variable" id="classAttribute_1d83a96149ae0e64667f2d5758cfa1bf1" prot="private" static="no" mutable="no">
8        <type><ref refid="classAssertXercesIsAlive" kindref="compound">AssertXercesIsAlive</ref></type>
9        <definition>AssertXercesIsAlive Attribute::dummy</definition>
10        <argsstring></argsstring>
11        <name>dummy</name>
12        <briefdescription>
13        </briefdescription>
14        <detaileddescription>
15<para>This private attribute has to be declared as the first attribute in the class. Only this way we can be sure it&apos;s constructor is called as the first and thus Xerces is initialized properly and right on time </para>        </detaileddescription>
16        <inbodydescription>
17        </inbodydescription>
18        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="131" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="131" bodyend="-1"/>
19      </memberdef>
20      <memberdef kind="variable" id="classAttribute_155346e03a6ac9d60f288c4fedab6731f" prot="private" static="no" mutable="no">
21        <type>const XMLCh *const</type>
22        <definition>const XMLCh* const Attribute::transcodedAttributeName</definition>
23        <argsstring></argsstring>
24        <name>transcodedAttributeName</name>
25        <briefdescription>
26<para>an attribute name </para>        </briefdescription>
27        <detaileddescription>
28        </detaileddescription>
29        <inbodydescription>
30        </inbodydescription>
31        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="134" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="134" bodyend="-1"/>
32      </memberdef>
33      </sectiondef>
34      <sectiondef kind="public-static-attrib">
35      <memberdef kind="variable" id="classAttribute_1d6474fd976f505e70e10c497199c6770" prot="public" static="yes" mutable="no">
36        <type>const <ref refid="classAttribute" kindref="compound">Attribute</ref></type>
37        <definition>const Attribute Attribute::help</definition>
38        <argsstring></argsstring>
39        <name>help</name>
40        <briefdescription>
41<para>Static member, an instance related to an attribute named &apos;help&apos;. </para>        </briefdescription>
42        <detaileddescription>
43        </detaileddescription>
44        <inbodydescription>
45        </inbodydescription>
46        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="149" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="149" bodyend="-1"/>
47        <referencedby refid="classUserInfo_11d402661b82feccb5265a70f65c242e1" compoundref="userinfo_8h" startline="297" endline="321">UserInfo::Disassembly</referencedby>
48      </memberdef>
49      <memberdef kind="variable" id="classAttribute_15f6cce980606fa8943857204aacb5478" prot="public" static="yes" mutable="no">
50        <type>const <ref refid="classAttribute" kindref="compound">Attribute</ref></type>
51        <definition>const Attribute Attribute::type</definition>
52        <argsstring></argsstring>
53        <name>type</name>
54        <briefdescription>
55<para>Static member, a constant instance related to an attribute named &apos;type&apos;. </para>        </briefdescription>
56        <detaileddescription>
57        </detaileddescription>
58        <inbodydescription>
59        </inbodydescription>
60        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="152" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="152" bodyend="-1"/>
61        <referencedby refid="classUserInfo_10f090c6525a3e8fb11634a553f467ede" compoundref="userinfo_8h" startline="226" endline="291">UserInfo::Assembly</referencedby>
62        <referencedby refid="classUserInfo_11d402661b82feccb5265a70f65c242e1" compoundref="userinfo_8h" startline="297" endline="321">UserInfo::Disassembly</referencedby>
63      </memberdef>
64      <memberdef kind="variable" id="classAttribute_1452441da4ebfda23cdc668943ffe8da7" prot="public" static="yes" mutable="no">
65        <type>const <ref refid="classAttribute" kindref="compound">Attribute</ref></type>
66        <definition>const Attribute Attribute::value</definition>
67        <argsstring></argsstring>
68        <name>value</name>
69        <briefdescription>
70<para>Static member, a constant instance related to the attribute named &apos;value&apos;. </para>        </briefdescription>
71        <detaileddescription>
72        </detaileddescription>
73        <inbodydescription>
74        </inbodydescription>
75        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="155" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="155" bodyend="-1"/>
76      </memberdef>
77      </sectiondef>
78      <sectiondef kind="public-func">
79      <memberdef kind="function" id="classAttribute_14c4c80e6b59e3356324ef02d0e92d813" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
80        <type></type>
81        <definition>Attribute::Attribute</definition>
82        <argsstring>(string attributeName)</argsstring>
83        <name>Attribute</name>
84        <param>
85          <type>string</type>
86          <declname>attributeName</declname>
87        </param>
88        <briefdescription>
89<para>Default constructor fixing a name of the related attribute. </para>        </briefdescription>
90        <detaileddescription>
91        </detaileddescription>
92        <inbodydescription>
93        </inbodydescription>
94        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="138" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="29" bodyend="33"/>
95      </memberdef>
96      <memberdef kind="function" id="classAttribute_128ab087bb886728670e4ae5791bc2ea8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
97        <type></type>
98        <definition>Attribute::~Attribute</definition>
99        <argsstring>()</argsstring>
100        <name>~Attribute</name>
101        <briefdescription>
102        </briefdescription>
103        <detaileddescription>
104        </detaileddescription>
105        <inbodydescription>
106        </inbodydescription>
107        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="140" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="35" bodyend="38"/>
108      </memberdef>
109      <memberdef kind="function" id="classAttribute_16ebbcaaf9c90a979e645f469e02bb940" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
110        <type>string &amp;</type>
111        <definition>string &amp; Attribute::Get</definition>
112        <argsstring>(DOMElement &amp;element) const </argsstring>
113        <name>Get</name>
114        <param>
115          <type>DOMElement &amp;</type>
116          <declname>element</declname>
117        </param>
118        <briefdescription>
119<para>This method parse DOMElement, finds proper attribute and returns its value. </para>        </briefdescription>
120        <detaileddescription>
121        </detaileddescription>
122        <inbodydescription>
123        </inbodydescription>
124        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="143" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="40" bodyend="44"/>
125        <referencedby refid="classUserInfo_10f090c6525a3e8fb11634a553f467ede" compoundref="userinfo_8h" startline="226" endline="291">UserInfo::Assembly</referencedby>
126      </memberdef>
127      <memberdef kind="function" id="classAttribute_1e011d84e2e3c40390807a8b8e58e3c35" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
128        <type>void</type>
129        <definition>void Attribute::Set</definition>
130        <argsstring>(DOMElement &amp;element, const string &amp;str) const </argsstring>
131        <name>Set</name>
132        <param>
133          <type>DOMElement &amp;</type>
134          <declname>element</declname>
135        </param>
136        <param>
137          <type>const string &amp;</type>
138          <declname>str</declname>
139        </param>
140        <briefdescription>
141<para>This method adds the passed string as an new attribute into the passed DOMElement. </para>        </briefdescription>
142        <detaileddescription>
143        </detaileddescription>
144        <inbodydescription>
145        </inbodydescription>
146        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="146" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="46" bodyend="52"/>
147        <referencedby refid="classUserInfo_11d402661b82feccb5265a70f65c242e1" compoundref="userinfo_8h" startline="297" endline="321">UserInfo::Disassembly</referencedby>
148      </memberdef>
149      </sectiondef>
150    <briefdescription>
151<para>Abstract class declaring general properties of a frame for data binding. </para>    </briefdescription>
152    <detaileddescription>
153    </detaileddescription>
154    <collaborationgraph>
155      <node id="641">
156        <label>Attribute</label>
157        <link refid="classAttribute"/>
158        <childnode refid="642" relation="usage">
159          <edgelabel>dummy</edgelabel>
160        </childnode>
161        <childnode refid="641" relation="usage">
162          <edgelabel>help
163value
164type</edgelabel>
165        </childnode>
166      </node>
167      <node id="642">
168        <label>AssertXercesIsAlive</label>
169        <link refid="classAssertXercesIsAlive"/>
170      </node>
171    </collaborationgraph>
172    <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="126" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="125" bodyend="156"/>
173    <listofallmembers>
174      <member refid="classAttribute_14c4c80e6b59e3356324ef02d0e92d813" prot="public" virt="non-virtual"><scope>Attribute</scope><name>Attribute</name></member>
175      <member refid="classAttribute_1d83a96149ae0e64667f2d5758cfa1bf1" prot="private" virt="non-virtual"><scope>Attribute</scope><name>dummy</name></member>
176      <member refid="classAttribute_16ebbcaaf9c90a979e645f469e02bb940" prot="public" virt="non-virtual"><scope>Attribute</scope><name>Get</name></member>
177      <member refid="classAttribute_1d6474fd976f505e70e10c497199c6770" prot="public" virt="non-virtual"><scope>Attribute</scope><name>help</name></member>
178      <member refid="classAttribute_1e011d84e2e3c40390807a8b8e58e3c35" prot="public" virt="non-virtual"><scope>Attribute</scope><name>Set</name></member>
179      <member refid="classAttribute_155346e03a6ac9d60f288c4fedab6731f" prot="private" virt="non-virtual"><scope>Attribute</scope><name>transcodedAttributeName</name></member>
180      <member refid="classAttribute_15f6cce980606fa8943857204aacb5478" prot="public" virt="non-virtual"><scope>Attribute</scope><name>type</name></member>
181      <member refid="classAttribute_1452441da4ebfda23cdc668943ffe8da7" prot="public" virt="non-virtual"><scope>Attribute</scope><name>value</name></member>
182      <member refid="classAttribute_128ab087bb886728670e4ae5791bc2ea8" prot="public" virt="non-virtual"><scope>Attribute</scope><name>~Attribute</name></member>
183    </listofallmembers>
184  </compounddef>
185</doxygen>
Note: See TracBrowser for help on using the browser.