Changeset 538 for library/doc/html/classbdm_1_1ParticularUI.html
- Timestamp:
- 08/16/09 18:14:04 (16 years ago)
- Files:
-
- 1 modified
-
library/doc/html/classbdm_1_1ParticularUI.html (modified) (6 diffs)
Legend:
- Unmodified
- Added
- Removed
-
library/doc/html/classbdm_1_1ParticularUI.html
r472 r538 5 5 <link href="doxygen.css" rel="stylesheet" type="text/css"> 6 6 </head><body> 7 <!-- Generated by Doxygen 1.5. 9-->7 <!-- Generated by Doxygen 1.5.8 --> 8 8 <script type="text/javascript"> 9 9 <!-- … … 68 68 </div> 69 69 <div class="contents"> 70 <h1>bdm::ParticularUI< T > Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" --><code>#include <<a class="el" href="user__info_8h _source.html">user_info.h</a>></code>70 <h1>bdm::ParticularUI< T > Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" --><code>#include <<a class="el" href="user__info_8h-source.html">user_info.h</a>></code> 71 71 <p> 72 72 … … 75 75 <tr><td></td></tr> 76 76 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 77 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a75820d3cad5d2034f25b2252ce6be7"></a><!-- doxytag: member="bdm::ParticularUI::ParticularUI" ref="3a75820d3cad5d2034f25b2252ce6be7" args="(const string &class_name)" --> 78 </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#3a75820d3cad5d2034f25b2252ce6be7">ParticularUI</a> (const string &class_name)</td></tr> 79 80 <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor used by the UIREGISTER macro. <br></td></tr> 77 81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14fea8c7372a3d0a736e4ed0b617702"></a><!-- doxytag: member="bdm::ParticularUI::new_instance" ref="a14fea8c7372a3d0a736e4ed0b617702" args="() const " --> 78 82 <a class="el" href="classbdm_1_1root.html">root</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#a14fea8c7372a3d0a736e4ed0b617702">new_instance</a> () const </td></tr> 79 83 80 <tr><td class="mdescLeft"> </td><td class="mdescRight">A method returning a brand new instance of class T, this method is the reason why there have to be a parameterless construcotor in class T. <br></td></tr> 81 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="3e3d8064ae10dfeddfe106a8dea1b038"></a><!-- doxytag: member="bdm::ParticularUI::factory" ref="3e3d8064ae10dfeddfe106a8dea1b038" args="(ParticularUI< epdf_harness >("epdf_harness"))" --> 82 template<> </td></tr> 83 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">const <a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a><br class="typebreak"> 84 < epdf_harness > & </td><td class="memTemplItemRight" valign="bottom"><b>factory</b> (<a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>< epdf_harness >("epdf_harness"))</td></tr> 85 86 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="d424cadb680b1a6e906744330df54e1d"></a><!-- doxytag: member="bdm::ParticularUI::factory" ref="d424cadb680b1a6e906744330df54e1d" args="(ParticularUI< mpdf_harness >("mpdf_harness"))" --> 87 template<> </td></tr> 88 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">const <a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a><br class="typebreak"> 89 < mpdf_harness > & </td><td class="memTemplItemRight" valign="bottom"><b>factory</b> (<a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>< mpdf_harness >("mpdf_harness"))</td></tr> 90 91 <tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr> 92 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18a208b7549160ae6aeb884dc2bcd90f"></a><!-- doxytag: member="bdm::ParticularUI::factory" ref="18a208b7549160ae6aeb884dc2bcd90f" args="" --> 93 static const <a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#18a208b7549160ae6aeb884dc2bcd90f">factory</a></td></tr> 94 95 <tr><td class="mdescLeft"> </td><td class="mdescRight">The only instance of this class (each type T has its own instance) which is used as a factory for processing related <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a>. <br></td></tr> 84 <tr><td class="mdescLeft"> </td><td class="mdescRight">A method returning a brand new instance of class T, this method is the reason why there have to be a parameterless constructor in class T. <br></td></tr> 96 85 <tr><td colspan="2"><br><h2>Private Types</h2></td></tr> 97 86 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> { <b>optional</b>, … … 99 88 }</td></tr> 100 89 101 <tr><td class="mdescLeft"> </td><td class="mdescRight">Enum ericaltype used to determine whether the data for concrete Settingis is compulsory or optional. <br></td></tr>90 <tr><td class="mdescLeft"> </td><td class="mdescRight">Enum type used to determine whether the data for concrete Settingis is compulsory or optional. <br></td></tr> 102 91 <tr><td colspan="2"><br><h2>Static Private Member Functions</h2></td></tr> 103 92 <tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr> 104 93 <tr><td colspan="2"><div class="groupText">The type T has to be a <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">bdm::root</a> descendant class <br><br></div></td></tr> 105 94 <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> 106 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#970297d6c758692135877dfa7a5eacb0">build</a> (const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>95 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#1f3d45184f803e1256cfc896b43ed2f8">build</a> (const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 107 96 108 97 <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> 109 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#b8b2512d4762463cbf23314d45f1c5b1">build</a> (const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>98 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#f02851b299aedeb891e30c4807903081">build</a> (const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 110 99 111 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="6e2da6a142fecf5f21e0bb86a7211cb4"></a><!-- doxytag: member="bdm::ParticularUI::build" ref="6e2da6a142fecf5f21e0bb86a7211cb4" args="(const Setting &element)" -->112 template<class T > </td></tr>113 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#6e2da6a142fecf5f21e0bb86a7211cb4">build</a> (const Setting &element)</td></tr>114 115 <tr><td class="mdescLeft"> </td><td class="mdescRight">The new instance of type T* is constructed and initialized with values stored in the Setting element. <br></td></tr>116 100 <tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr> 117 101 <tr><td colspan="2"><div class="groupText">The type T has to be int, double, string, vec, ivec or mat. <br><br></div></td></tr> … … 147 131 148 132 <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant instance is stored in the new child Setting appended to the passed element. <br></td></tr> 133 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7a307cd313e516b6d5629046dd321039"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="7a307cd313e516b6d5629046dd321039" args="(const shared_ptr< T > &instance, Setting &element, const string &name="")" --> 134 template<class T > </td></tr> 135 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><b>save</b> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>< T > &instance, Setting &element, const string &name="")</td></tr> 136 149 137 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4514f93573a9d9126c506d176fbd3163"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="4514f93573a9d9126c506d176fbd3163" args="(const Array< T > &array_to_save, Setting &element, const string &name="")" --> 150 138 template<class T > </td></tr> … … 181 169 class bdm::ParticularUI< T ></h3> 182 170 183 The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> descendant class which is not intended for direct use. It should be accessed within the <a class="el" href="user__info_8h.html#4f9de2f17e844047726487b99def99c6" title="Macro for registration of class into map of user-infos, registered class is scriptable...">UIREGISTER</a>macro only. <a class="el" href="ui_page.html">User Infos and their use</a> <hr>The documentation for this class was generated from the following file:<ul>184 <li><a class="el" href="user__info_8h _source.html">user_info.h</a></ul>171 The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> descendant class which is not intended for direct use. It should be accessed within the UIREGISTER macro only. <a class="el" href="ui_page.html">User Infos and their use</a> <hr>The documentation for this class was generated from the following file:<ul> 172 <li><a class="el" href="user__info_8h-source.html">user_info.h</a></ul> 185 173 </div> 186 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:06:572009 for mixpp by 174 <hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by 187 175 <a href="http://www.doxygen.org/index.html"> 188 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5. 9</small></address>176 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 189 177 </body> 190 178 </html>
