Changeset 171 for doc/html/classCompoundUserInfo.html
- Timestamp:
- 09/24/08 13:08:07 (16 years ago)
- Files:
-
- 1 copied
-
doc/html/classCompoundUserInfo.html (copied) (copied from doc/html/classUserInfo.html) (11 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/html/classCompoundUserInfo.html
r162 r171 1 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 3 <title>mixpp: UserInfo ClassReference</title>3 <title>mixpp: CompoundUserInfo< T > Class Template Reference</title> 4 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 5 <link href="tabs.css" rel="stylesheet" type="text/css"> … … 24 24 </div> 25 25 <div class="contents"> 26 <h1> UserInfo Class Reference</h1><!-- doxytag: class="UserInfo" --><!-- doxytag: inherits="BindingFrame" --><a class="el" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo<T>...">UserInfo</a> is an abstract is for internal purposes only. Use CompoundUserInfo<T> or ValuedUserInfo<T> instead. The raison d'etre of this class is to allow pointers to its templated descendants.26 <h1>CompoundUserInfo< T > Class Template Reference</h1><!-- doxytag: class="CompoundUserInfo" --><!-- doxytag: inherits="TypedUserInfo" -->The main userinfo template class. You should derive this class whenever you need a new userinfo of a class which is compound from smaller elements (all having its own userinfo class prepared). 27 27 <a href="#_details">More...</a> 28 28 <p> … … 30 30 <p> 31 31 <div class="dynheader"> 32 Inheritance diagram for UserInfo:</div>32 Inheritance diagram for CompoundUserInfo< T >:</div> 33 33 <div class="dynsection"> 34 <p><center><img src="class UserInfo__inherit__graph.png" border="0" usemap="#UserInfo__inherit__map" alt="Inheritance graph"></center>35 <map name=" UserInfo__inherit__map">36 <area shape="rect" href="class TypedUserInfo.html" title="TypeUserInfo is still an abstract class, but contrary to the UserInfo class it is..." alt="" coords="292,211,439,237"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\< double \>" alt="" coords="563,185,747,212"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\< int \>" alt="" coords="577,360,732,387"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\< string \>" alt="" coords="567,436,743,463"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\< Car \>" alt="" coords="573,57,736,84"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\< bool \>" alt="" coords="571,487,739,513"><area shape="rect" href="classTypedUserInfo.html" title="TypedUserInfo\< Bike \>" alt="" coords="571,7,739,33"><area shape="rect" href="classBindingFrame.html" title="Abstract class declaring general properties of a frame for data binding." alt="" coords="7,211,113,237"><area shape="rect" href="classCompoundUserInfo.html" title="The main userinfo template class. You should derive this class whenever you need..." alt="" coords="564,135,745,161"><area shape="rect" href="classValuedUserInfo.html" title="The main userinfo template class. It should be derived whenever you need a new userinfo..." alt="" coords="577,268,732,295"><area shape="rect" href="classCompoundUserInfo.html" title="CompoundUserInfo\< Car \>" alt="" coords="873,135,1068,161"><area shape="rect" href="classCompoundUserInfo.html" title="CompoundUserInfo\< Bike \>" alt="" coords="871,49,1071,76"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\< double \>" alt="" coords="876,203,1065,229"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\< int \>" alt="" coords="889,301,1052,328"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\< string \>" alt="" coords="879,368,1063,395"><area shape="rect" href="classValuedUserInfo.html" title="ValuedUserInfo\< bool \>" alt="" coords="884,436,1057,463"></map>34 <p><center><img src="classCompoundUserInfo__inherit__graph.png" border="0" usemap="#CompoundUserInfo_3_01T_01_4__inherit__map" alt="Inheritance graph"></center> 35 <map name="CompoundUserInfo_3_01T_01_4__inherit__map"> 36 <area shape="rect" href="classCompoundUserInfo.html" title="CompoundUserInfo\< Car \>" alt="" coords="5,343,200,369"><area shape="rect" href="classCompoundUserInfo.html" title="CompoundUserInfo\< Bike \>" alt="" coords="224,343,424,369"><area shape="rect" href="classTypedUserInfo.html" title="TypeUserInfo is still an abstract class, but contrary to the UserInfo class it is..." alt="" coords="105,167,252,193"><area shape="rect" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo<T>..." alt="" coords="141,87,216,113"><area shape="rect" href="classBindingFrame.html" title="Abstract class declaring general properties of a frame for data binding." alt="" coords="125,7,232,33"></map> 37 37 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> 38 38 <div class="dynheader"> 39 Collaboration diagram for UserInfo:</div>39 Collaboration diagram for CompoundUserInfo< T >:</div> 40 40 <div class="dynsection"> 41 <p><center><img src="class UserInfo__coll__graph.png" border="0" usemap="#UserInfo__coll__map" alt="Collaboration graph"></center>42 <map name=" UserInfo__coll__map">43 <area shape="rect" href="class BindingFrame.html" title="Abstract class declaring general properties of a frame for data binding." alt="" coords="24,103,131,129"><area shape="rect" href="classAssertXercesIsAlive.html" title="Class initializing Xerces library." alt="" coords="5,7,149,33"></map>41 <p><center><img src="classCompoundUserInfo__coll__graph.png" border="0" usemap="#CompoundUserInfo_3_01T_01_4__coll__map" alt="Collaboration graph"></center> 42 <map name="CompoundUserInfo_3_01T_01_4__coll__map"> 43 <area shape="rect" href="classTypedUserInfo.html" title="TypeUserInfo is still an abstract class, but contrary to the UserInfo class it is..." alt="" coords="83,295,229,321"><area shape="rect" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo<T>..." alt="" coords="119,215,193,241"><area shape="rect" href="classBindingFrame.html" title="Abstract class declaring general properties of a frame for data binding." alt="" coords="24,103,131,129"><area shape="rect" href="classAssertXercesIsAlive.html" title="Class initializing Xerces library." alt="" coords="5,7,149,33"></map> 44 44 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> 45 45 46 46 <p> 47 <a href="class UserInfo-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">47 <a href="classCompoundUserInfo-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 48 48 <tr><td></td></tr> 49 49 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> … … 52 52 53 53 <tr><td class="memTemplParams" nowrap colspan="2">template<class T> </td></tr> 54 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classUserInfo.html#1d402661b82feccb5265a70f65c242e1">Disassembly</a> (T & instance, DOMElement &element, const string tagName, const string help)</td></tr>54 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classUserInfo.html#1d402661b82feccb5265a70f65c242e1">Disassembly</a> (T &<a class="el" href="classTypedUserInfo.html#c7ad10a9ff002383518155c965ade85c">instance</a>, DOMElement &element, const string tagName, const string help)</td></tr> 55 55 56 56 <tr><td class="memTemplParams" nowrap colspan="2">template<class T> </td></tr> 57 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classUserInfo.html#917b2257abc31b94c89ef3cd270e4a42">Disassembly</a> (T & instance, DOMElement &element, const string tagName)</td></tr>57 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classUserInfo.html#917b2257abc31b94c89ef3cd270e4a42">Disassembly</a> (T &<a class="el" href="classTypedUserInfo.html#c7ad10a9ff002383518155c965ade85c">instance</a>, DOMElement &element, const string tagName)</td></tr> 58 58 59 59 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> 60 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0bccb19c6b819cf9f763e985c573ae8f"></a><!-- doxytag: member="UserInfo::UserInfo" ref="0bccb19c6b819cf9f763e985c573ae8f" args="(const string &userFriendlyTypeName, const string &typeNameByRTTI)" --> 61 </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#0bccb19c6b819cf9f763e985c573ae8f">UserInfo</a> (const string &userFriendlyTypeName, const string &typeNameByRTTI)</td></tr> 62 63 <tr><td class="mdescLeft"> </td><td class="mdescRight">default constructor <br></td></tr> 64 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2244bd5181c3d1e70f3a6be2b72e9424"></a><!-- doxytag: member="UserInfo::XMLCh2str" ref="2244bd5181c3d1e70f3a6be2b72e9424" args="(const XMLCh *const XMLCh_str)" --> 60 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2265e447e2f48550c5d8d479119bbb3"></a><!-- doxytag: member="CompoundUserInfo::CompoundUserInfo" ref="e2265e447e2f48550c5d8d479119bbb3" args="(string userFriendlyTypeName)" --> 61 </td><td class="memItemRight" valign="bottom"><b>CompoundUserInfo</b> (string userFriendlyTypeName)</td></tr> 62 63 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2244bd5181c3d1e70f3a6be2b72e9424"></a><!-- doxytag: member="CompoundUserInfo::XMLCh2str" ref="2244bd5181c3d1e70f3a6be2b72e9424" args="(const XMLCh *const XMLCh_str)" --> 65 64 string </td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#2244bd5181c3d1e70f3a6be2b72e9424">XMLCh2str</a> (const XMLCh *const XMLCh_str)</td></tr> 66 65 67 66 <tr><td class="mdescLeft"> </td><td class="mdescRight">function which transcodes Xerces' XMLCh-based strings into C++ strings <br></td></tr> 68 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="820e4df85c0dc545e3079e407fcdbbaa"></a><!-- doxytag: member=" UserInfo::removeSpaces" ref="820e4df85c0dc545e3079e407fcdbbaa" args="(const string &str)" -->67 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="820e4df85c0dc545e3079e407fcdbbaa"></a><!-- doxytag: member="CompoundUserInfo::removeSpaces" ref="820e4df85c0dc545e3079e407fcdbbaa" args="(const string &str)" --> 69 68 string </td><td class="memItemRight" valign="bottom"><b>removeSpaces</b> (const string &<a class="el" href="classstr.html">str</a>)</td></tr> 70 69 71 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6d068c261d4fc3a0a4d1305ade1483d"></a><!-- doxytag: member="UserInfo::AssemblyComponentsFromXML" ref="c6d068c261d4fc3a0a4d1305ade1483d" args="(DOMElement &element)=0" --> 72 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#c6d068c261d4fc3a0a4d1305ade1483d">AssemblyComponentsFromXML</a> (DOMElement &element)=0</td></tr> 73 74 <tr><td class="mdescLeft"> </td><td class="mdescRight">This method parse DOMElement, finds proper DOMNode and fills binded data accordingly. <br></td></tr> 75 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d4dc5902ee71a473983d6a8fa3c8b7a"></a><!-- doxytag: member="UserInfo::ReleaseMemory" ref="8d4dc5902ee71a473983d6a8fa3c8b7a" args="()" --> 76 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#8d4dc5902ee71a473983d6a8fa3c8b7a">ReleaseMemory</a> ()</td></tr> 77 78 <tr><td class="mdescLeft"> </td><td class="mdescRight">A method for releasing memory allocated within the 'AssemblyComponentsFromXML()' method. <br></td></tr> 79 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBindingFrame.html#0c207ed6e5a4c975ed5bc9a758a063ca">DisassemblyComponentsToXML</a> (DOMElement &element)=0</td></tr> 70 <tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr> 71 <tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classTypedUserInfo.html">TypedUserInfo</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTypedUserInfo.html#c7ad10a9ff002383518155c965ade85c">instance</a></td></tr> 80 72 81 73 <tr><td colspan="2"><br><h2>Classes</h2></td></tr> 82 <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>StringToUIMap</b></td></tr> 83 74 <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCompoundUserInfo_1_1BindedElement.html">BindedElement</a></td></tr> 75 76 <tr><td class="mdescLeft"> </td><td class="mdescRight">Templated class binding inner element with its XML tag and automating data transfers in both directions. <a href="classCompoundUserInfo_1_1BindedElement.html#_details">More...</a><br></td></tr> 84 77 </table> 85 78 <hr><a name="_details"></a><h2>Detailed Description</h2> 86 <a class="el" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo<T>...">UserInfo</a> is an abstract is for internal purposes only. Use CompoundUserInfo<T> or ValuedUserInfo<T> instead. The raison d'etre of this class is to allow pointers to its templated descendants. 87 <p> 88 Also, the main functions of the whole <a class="el" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo<T>...">UserInfo</a> library are included within this class, see static methods 'Assembly' and 'Disassembly'. <hr><h2>Member Function Documentation</h2> 89 <a class="anchor" name="0f090c6525a3e8fb11634a553f467ede"></a><!-- doxytag: member="UserInfo::Assembly" ref="0f090c6525a3e8fb11634a553f467ede" args="(DOMElement &element, const string tagName)" --> 79 <h3>template<typename T><br> 80 class CompoundUserInfo< T ></h3> 81 82 The main userinfo template class. You should derive this class whenever you need a new userinfo of a class which is compound from smaller elements (all having its own userinfo class prepared). 83 <p> 84 To bind some inner element to its own userinfo class, and also to automate its assembling and disassembling, it is necessary to create a instance of an inner templated class BindedElement<T>. Those attributes have to be initialized in constructor of a new compound userinfo this way:<p> 85 <div class="fragment"><pre class="fragment"><span class="keyword">class </span>BikeUI: <span class="keyword">public</span> <a class="code" href="classCompoundUserInfo.html" title="The main userinfo template class. You should derive this class whenever you need...">CompoundUserInfo</a><Bike> 86 { 87 <span class="keyword">private</span>: 88 BindedElement<int> year; 89 BindedElement<bool> lights; 90 BindedElement<string> manufacturer; 91 <span class="keyword">public</span>: 92 BikeUI() 93 :<a class="code" href="classCompoundUserInfo.html" title="The main userinfo template class. You should derive this class whenever you need...">CompoundUserInfo</a><Bike>(<span class="stringliteral">"bike"</span>), 94 year( this, <span class="stringliteral">"year"</span>, 0 ), 95 lights( this, <span class="stringliteral">"electric lights"</span>, false ), 96 manufacturer( this, <span class="stringliteral">"manufacturer"</span>, <span class="stringliteral">"unknown"</span>) 97 { 98 } 99 100 ... 101 } 102 </pre></div> <hr><h2>Member Function Documentation</h2> 103 <a class="anchor" name="0f090c6525a3e8fb11634a553f467ede"></a><!-- doxytag: member="CompoundUserInfo::Assembly" ref="0f090c6525a3e8fb11634a553f467ede" args="(DOMElement &element, const string tagName)" --> 90 104 <div class="memitem"> 91 105 <div class="memproto"> … … 108 122 <td></td> 109 123 <td>)</td> 110 <td></td><td></td><td><code> [inline, static ]</code></td>124 <td></td><td></td><td><code> [inline, static, inherited]</code></td> 111 125 </tr> 112 126 </table> … … 120 134 </div> 121 135 </div><p> 122 <a class="anchor" name="1d402661b82feccb5265a70f65c242e1"></a><!-- doxytag: member=" UserInfo::Disassembly" ref="1d402661b82feccb5265a70f65c242e1" args="(T &instance, DOMElement &element, const string tagName, const string help)" -->136 <a class="anchor" name="1d402661b82feccb5265a70f65c242e1"></a><!-- doxytag: member="CompoundUserInfo::Disassembly" ref="1d402661b82feccb5265a70f65c242e1" args="(T &instance, DOMElement &element, const string tagName, const string help)" --> 123 137 <div class="memitem"> 124 138 <div class="memproto"> … … 153 167 <td></td> 154 168 <td>)</td> 155 <td></td><td></td><td><code> [inline, static ]</code></td>169 <td></td><td></td><td><code> [inline, static, inherited]</code></td> 156 170 </tr> 157 171 </table> … … 163 177 <p>References <a class="el" href="userinfo_8h-source.html#l00149">Attribute::help</a>, <a class="el" href="userinfo_8cpp-source.html#l00046">Attribute::Set()</a>, and <a class="el" href="userinfo_8h-source.html#l00152">Attribute::type</a>.</p> 164 178 165 <p>Referenced by <a class="el" href="userinfo_8h-source.html#l00327"> Disassembly()</a>, and <a class="el" href="userinfo_8h-source.html#l00479">CompoundUserInfo< T >::BindedElement< U >::DisassemblyComponentsToXML()</a>.</p>166 167 </div> 168 </div><p> 169 <a class="anchor" name="917b2257abc31b94c89ef3cd270e4a42"></a><!-- doxytag: member=" UserInfo::Disassembly" ref="917b2257abc31b94c89ef3cd270e4a42" args="(T &instance, DOMElement &element, const string tagName)" -->179 <p>Referenced by <a class="el" href="userinfo_8h-source.html#l00327">UserInfo::Disassembly()</a>, and <a class="el" href="userinfo_8h-source.html#l00479">CompoundUserInfo< T >::BindedElement< U >::DisassemblyComponentsToXML()</a>.</p> 180 181 </div> 182 </div><p> 183 <a class="anchor" name="917b2257abc31b94c89ef3cd270e4a42"></a><!-- doxytag: member="CompoundUserInfo::Disassembly" ref="917b2257abc31b94c89ef3cd270e4a42" args="(T &instance, DOMElement &element, const string tagName)" --> 170 184 <div class="memitem"> 171 185 <div class="memproto"> … … 194 208 <td></td> 195 209 <td>)</td> 196 <td></td><td></td><td><code> [inline, static ]</code></td>210 <td></td><td></td><td><code> [inline, static, inherited]</code></td> 197 211 </tr> 198 212 </table> … … 202 216 <p> 203 217 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. 204 <p>References <a class="el" href="userinfo_8h-source.html#l00297">Disassembly()</a>.</p> 205 206 </div> 207 </div><p> 208 <a class="anchor" name="0c207ed6e5a4c975ed5bc9a758a063ca"></a><!-- doxytag: member="UserInfo::DisassemblyComponentsToXML" ref="0c207ed6e5a4c975ed5bc9a758a063ca" args="(DOMElement &element)=0" --> 209 <div class="memitem"> 210 <div class="memproto"> 211 <table class="memname"> 212 <tr> 213 <td class="memname">virtual bool BindingFrame::DisassemblyComponentsToXML </td> 214 <td>(</td> 215 <td class="paramtype">DOMElement & </td> 216 <td class="paramname"> <em>element</em> </td> 217 <td> ) </td> 218 <td><code> [pure virtual, inherited]</code></td> 219 </tr> 220 </table> 221 </div> 222 <div class="memdoc"> 223 224 <p> 225 This method reads binded data, fill them into a new DOMNode, which then appends to the passed DOMElement 226 <p>Implemented in <a class="el" href="classCompoundUserInfo_1_1BindedElement.html#6ef55cedb98f5d2dbcf92730f2fed939">CompoundUserInfo< T >::BindedElement< U ></a>.</p> 227 218 <p>References <a class="el" href="userinfo_8h-source.html#l00297">UserInfo::Disassembly()</a>.</p> 219 220 </div> 221 </div><p> 222 <hr><h2>Member Data Documentation</h2> 223 <a class="anchor" name="c7ad10a9ff002383518155c965ade85c"></a><!-- doxytag: member="CompoundUserInfo::instance" ref="c7ad10a9ff002383518155c965ade85c" args="" --> 224 <div class="memitem"> 225 <div class="memproto"> 226 <div class="memtemplate"> 227 template<typename T> </div> 228 <table class="memname"> 229 <tr> 230 <td class="memname">const <a class="el" href="classTypedUserInfo.html">TypedUserInfo</a><T>& <a class="el" href="classTypedUserInfo.html">TypedUserInfo</a>< T >::<a class="el" href="classTypedUserInfo.html#c7ad10a9ff002383518155c965ade85c">instance</a><code> [static, protected, inherited]</code> </td> 231 </tr> 232 </table> 233 </div> 234 <div class="memdoc"> 235 236 <p> 237 the only instance of this class (each type T has its own instance) which is used as a factory for processing related userinfos 228 238 </div> 229 239 </div><p> … … 231 241 <li>work/git/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul> 232 242 </div> 233 <hr size="1"><address style="text-align: right;"><small>Generated on T hu Sep 4 19:28:142008 for mixpp by 243 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 23 16:00:49 2008 for mixpp by 234 244 <a href="http://www.doxygen.org/index.html"> 235 245 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
