73 | | <h1>bdm::UI Class Reference</h1><!-- doxytag: class="bdm::UI" --> |
74 | | <p><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> is an abstract class which collects all the auxiliary functions useful to prepare some concrete user-infos. |
75 | | <a href="#_details">More...</a></p> |
76 | | <hr/><a name="_details"></a><h2>Detailed Description</h2> |
77 | | <p><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> is an abstract class which collects all the auxiliary functions useful to prepare some concrete user-infos. </p> |
78 | | <p>See static methods 'build', 'get' and 'save'. Writing user-infos with these methods is rather simple. The rest of this class is intended for internal purposes only. Its meaning is to allow pointers to its templated descendant ParticularUI<T>.</p> |
79 | | <p><a class="el" href="ui_page.html">User Infos and their use</a> </p> |
80 | | |
81 | | <p><code>#include <<a class="el" href="user__info_8h_source.html">user_info.h</a>></code></p> |
82 | | |
83 | | <p><a href="classbdm_1_1UI-members.html">List of all members.</a></p> |
84 | | <table border="0" cellpadding="0" cellspacing="0"> |
85 | | <tr><td colspan="2"><h2>Classes</h2></td></tr> |
86 | | <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>MappedUI</b></td></tr> |
87 | | <tr><td colspan="2"><h2>Public Types</h2></td></tr> |
88 | | <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> { <b>optional</b>, |
| 70 | <h1>bdm::UI Class Reference</h1><!-- doxytag: class="bdm::UI" --><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> is an abstract class which collects all the auxiliary functions useful to prepare some concrete user-infos. |
| 71 | <a href="#_details">More...</a> |
| 72 | <p> |
| 73 | <code>#include <<a class="el" href="user__info_8h_source.html">user_info.h</a>></code> |
| 74 | <p> |
| 75 | |
| 76 | <p> |
| 77 | <a href="classbdm_1_1UI-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
| 78 | <tr><td></td></tr> |
| 79 | <tr><td colspan="2"><br><h2>Classes</h2></td></tr> |
| 80 | <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>MappedUI</b></td></tr> |
| 81 | |
| 82 | <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> |
| 83 | <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>, |
102 | | <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp2f6254f904d5aa502f9248135b8a1928"></a> The type T has to be int, double, string, vec, ivec or mat. </p> |
103 | | <br/><br/></div></td></tr> |
104 | | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
105 | | <tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#acd1667e6fec99ec64dabcb3ca2ff922d">get</a> (T &instance, const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> |
106 | | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
107 | | <tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a6fb95ccb13515a3f23080a397dacaa0e">get</a> (T &instance, const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> |
108 | | <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a7d2ea138c7285565507fa61fbd9b038f"></a><!-- doxytag: member="bdm::UI::get" ref="a7d2ea138c7285565507fa61fbd9b038f" args="(T &instance, const Setting &element)" --> |
| 98 | <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> |
| 99 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
| 100 | <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cd1667e6fec99ec64dabcb3ca2ff922d">get</a> (T &instance, const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> |
| 101 | |
| 102 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
| 103 | <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#6fb95ccb13515a3f23080a397dacaa0e">get</a> (T &instance, const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> |
| 104 | |
| 105 | <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7d2ea138c7285565507fa61fbd9b038f"></a><!-- doxytag: member="bdm::UI::get" ref="7d2ea138c7285565507fa61fbd9b038f" args="(T &instance, const Setting &element)" --> |
113 | | <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpdc7b7e904f3afe234da7899219782a1e"></a> The type T has to be int, double, string, vec, ivec or mat, or pointer to any <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant. </p> |
114 | | <br/><br/></div></td></tr> |
115 | | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
116 | | <tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a81ce18ed0bb9993a634db2b99612ad66">get</a> (Array< T > &array_to_load, const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> |
117 | | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
118 | | <tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a29e450ed5560f81ef2f845e7b1021b71">get</a> (Array< T > &array_to_load, const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> |
119 | | <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ac9fad8376d2f0857e719511f92f93998"></a><!-- doxytag: member="bdm::UI::get" ref="ac9fad8376d2f0857e719511f92f93998" args="(Array< T > &array_to_load, const Setting &element)" --> |
| 111 | <tr><td colspan="2"><div class="groupText">The type T has to be int, double, string, vec, ivec or mat, or pointer to any <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant. <br><br></div></td></tr> |
| 112 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
| 113 | <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#81ce18ed0bb9993a634db2b99612ad66">get</a> (Array< T > &array_to_load, const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> |
| 114 | |
| 115 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
| 116 | <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#29e450ed5560f81ef2f845e7b1021b71">get</a> (Array< T > &array_to_load, const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> |
| 117 | |
| 118 | <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c9fad8376d2f0857e719511f92f93998"></a><!-- doxytag: member="bdm::UI::get" ref="c9fad8376d2f0857e719511f92f93998" args="(Array< T > &array_to_load, const Setting &element)" --> |
135 | | <tr><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a4514f93573a9d9126c506d176fbd3163">save</a> (const Array< T > &array_to_save, Setting &element, const string &name="")</td></tr> |
136 | | <tr><td class="mdescLeft"> </td><td class="mdescRight">An Array<T> instance is stored in the new child Setting appended to the passed element. <br/></td></tr> |
137 | | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42e908a4f1b09d701be69c8784a02df7"></a><!-- doxytag: member="bdm::UI::save" ref="a42e908a4f1b09d701be69c8784a02df7" args="(const mat &matrix, Setting &element, const string &name="")" --> |
138 | | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a42e908a4f1b09d701be69c8784a02df7">save</a> (const mat &matrix, Setting &element, const string &name="")</td></tr> |
139 | | <tr><td class="mdescLeft"> </td><td class="mdescRight">A matrix(of type mat) is stored in the new child Setting appended to the passed element. <br/></td></tr> |
140 | | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::UI::save" ref="acc2afb61a772d8571f7bb19065da4695" args="(const ivec &vec, Setting &element, const string &name="")" --> |
141 | | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#acc2afb61a772d8571f7bb19065da4695">save</a> (const ivec &vec, Setting &element, const string &name="")</td></tr> |
142 | | <tr><td class="mdescLeft"> </td><td class="mdescRight">An integer vector (of type ivec) is stored in the new child Setting appended to the passed element. <br/></td></tr> |
143 | | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c3b1846b2f29fb70e6a9d789daab808"></a><!-- doxytag: member="bdm::UI::save" ref="a7c3b1846b2f29fb70e6a9d789daab808" args="(const vec &vector, Setting &element, const string &name="")" --> |
144 | | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a7c3b1846b2f29fb70e6a9d789daab808">save</a> (const vec &vector, Setting &element, const string &name="")</td></tr> |
145 | | <tr><td class="mdescLeft"> </td><td class="mdescRight">A double vector (of type vec) is stored in the new child Setting appended to the passed element. <br/></td></tr> |
146 | | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c822efd5f8550480d0756352d430c05"></a><!-- doxytag: member="bdm::UI::save" ref="a7c822efd5f8550480d0756352d430c05" args="(const string &str, Setting &element, const string &name="")" --> |
147 | | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a7c822efd5f8550480d0756352d430c05">save</a> (const string &<a class="el" href="classbdm_1_1str.html">str</a>, Setting &element, const string &name="")</td></tr> |
148 | | <tr><td class="mdescLeft"> </td><td class="mdescRight">A string is stored in the new child Setting appended to the passed element. <br/></td></tr> |
149 | | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cd58216bcd732856846d18503c92d48"></a><!-- doxytag: member="bdm::UI::save" ref="a8cd58216bcd732856846d18503c92d48" args="(const int &integer, Setting &element, const string &name="")" --> |
150 | | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a8cd58216bcd732856846d18503c92d48">save</a> (const int &integer, Setting &element, const string &name="")</td></tr> |
151 | | <tr><td class="mdescLeft"> </td><td class="mdescRight">An integer is stored in the new child Setting appended to the passed element. <br/></td></tr> |
152 | | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e943ed7b3e65c9fd2842670fa8cf4a8"></a><!-- doxytag: member="bdm::UI::save" ref="a4e943ed7b3e65c9fd2842670fa8cf4a8" args="(const double &real, Setting &element, const string &name="")" --> |
153 | | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a4e943ed7b3e65c9fd2842670fa8cf4a8">save</a> (const double &real, Setting &element, const string &name="")</td></tr> |
154 | | <tr><td class="mdescLeft"> </td><td class="mdescRight">A double is stored in the new child Setting appended to the passed element. <br/></td></tr> |
155 | | <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> |
156 | | <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#ad60234c0673f345424329894b9b0cef8">UI</a> (const string &class_name, const type_info *const class_type_info)</td></tr> |
157 | | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for internal use only, see. <a href="#ad60234c0673f345424329894b9b0cef8"></a><br/></td></tr> |
| 136 | <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#4514f93573a9d9126c506d176fbd3163">save</a> (const Array< T > &array_to_save, Setting &element, const string &name="")</td></tr> |
| 137 | |
| 138 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An Array<T> instance is stored in the new child Setting appended to the passed element. <br></td></tr> |
| 139 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42e908a4f1b09d701be69c8784a02df7"></a><!-- doxytag: member="bdm::UI::save" ref="42e908a4f1b09d701be69c8784a02df7" args="(const mat &matrix, Setting &element, const string &name="")" --> |
| 140 | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#42e908a4f1b09d701be69c8784a02df7">save</a> (const mat &matrix, Setting &element, const string &name="")</td></tr> |
| 141 | |
| 142 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A matrix(of type mat) is stored in the new child Setting appended to the passed element. <br></td></tr> |
| 143 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::UI::save" ref="cc2afb61a772d8571f7bb19065da4695" args="(const ivec &vec, Setting &element, const string &name="")" --> |
| 144 | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cc2afb61a772d8571f7bb19065da4695">save</a> (const ivec &vec, Setting &element, const string &name="")</td></tr> |
| 145 | |
| 146 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An integer vector (of type ivec) is stored in the new child Setting appended to the passed element. <br></td></tr> |
| 147 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c3b1846b2f29fb70e6a9d789daab808"></a><!-- doxytag: member="bdm::UI::save" ref="7c3b1846b2f29fb70e6a9d789daab808" args="(const vec &vector, Setting &element, const string &name="")" --> |
| 148 | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7c3b1846b2f29fb70e6a9d789daab808">save</a> (const vec &vector, Setting &element, const string &name="")</td></tr> |
| 149 | |
| 150 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A double vector (of type vec) is stored in the new child Setting appended to the passed element. <br></td></tr> |
| 151 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c822efd5f8550480d0756352d430c05"></a><!-- doxytag: member="bdm::UI::save" ref="7c822efd5f8550480d0756352d430c05" args="(const string &str, Setting &element, const string &name="")" --> |
| 152 | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7c822efd5f8550480d0756352d430c05">save</a> (const string &<a class="el" href="classbdm_1_1str.html">str</a>, Setting &element, const string &name="")</td></tr> |
| 153 | |
| 154 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A string is stored in the new child Setting appended to the passed element. <br></td></tr> |
| 155 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8cd58216bcd732856846d18503c92d48"></a><!-- doxytag: member="bdm::UI::save" ref="8cd58216bcd732856846d18503c92d48" args="(const int &integer, Setting &element, const string &name="")" --> |
| 156 | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#8cd58216bcd732856846d18503c92d48">save</a> (const int &integer, Setting &element, const string &name="")</td></tr> |
| 157 | |
| 158 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An integer is stored in the new child Setting appended to the passed element. <br></td></tr> |
| 159 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e943ed7b3e65c9fd2842670fa8cf4a8"></a><!-- doxytag: member="bdm::UI::save" ref="4e943ed7b3e65c9fd2842670fa8cf4a8" args="(const double &real, Setting &element, const string &name="")" --> |
| 160 | static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#4e943ed7b3e65c9fd2842670fa8cf4a8">save</a> (const double &real, Setting &element, const string &name="")</td></tr> |
| 161 | |
| 162 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A double is stored in the new child Setting appended to the passed element. <br></td></tr> |
| 163 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
| 164 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#d60234c0673f345424329894b9b0cef8">UI</a> (const string &class_name, const type_info *const class_type_info)</td></tr> |
| 165 | |
| 166 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for internal use only, see. <a href="#d60234c0673f345424329894b9b0cef8"></a><br></td></tr> |
212 | | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
213 | | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
214 | | </tr> |
215 | | <tr> |
216 | | <td></td> |
217 | | <td>)</td> |
218 | | <td></td><td></td><td><code> [inline, static]</code></td> |
219 | | </tr> |
220 | | </table> |
221 | | </div> |
222 | | <div class="memdoc"> |
223 | | <p>The new instance of type T* is constructed and initialized with values stored in the Setting element[index]</p> |
224 | | <p>If there is not any sub-element indexed by index, and settingPresence is optional, an empty shared_ptr<T> is returned. When settingPresence is compulsory, the returned shared_ptr<T> is never empty (an exception is thrown when the object isn't found). </p> |
225 | | |
226 | | </div> |
227 | | </div> |
228 | | <a class="anchor" id="a1f3d45184f803e1256cfc896b43ed2f8"></a><!-- doxytag: member="bdm::UI::build" ref="a1f3d45184f803e1256cfc896b43ed2f8" args="(const Setting &element, const string &name, SettingPresence settingPresence=optional)" --> |
229 | | <div class="memitem"> |
230 | | <div class="memproto"> |
231 | | <div class="memtemplate"> |
232 | | template<class T > </div> |
233 | | <table class="memname"> |
234 | | <tr> |
235 | | <td class="memname">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a><T> bdm::UI::build </td> |
| 227 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
| 228 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
| 229 | </tr> |
| 230 | <tr> |
| 231 | <td></td> |
| 232 | <td>)</td> |
| 233 | <td></td><td></td><td><code> [inline, static]</code></td> |
| 234 | </tr> |
| 235 | </table> |
| 236 | </div> |
| 237 | <div class="memdoc"> |
| 238 | |
| 239 | <p> |
| 240 | The new instance of type T* is constructed and initialized with values stored in the Setting element[index]<p> |
| 241 | If there is not any sub-element indexed by index, and settingPresence is optional, an empty <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr<T></a> is returned. When settingPresence is compulsory, the returned <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr<T></a> is never empty (an exception is thrown when the object isn't found). |
| 242 | </div> |
| 243 | </div><p> |
| 244 | <a class="anchor" name="1f3d45184f803e1256cfc896b43ed2f8"></a><!-- doxytag: member="bdm::UI::build" ref="1f3d45184f803e1256cfc896b43ed2f8" args="(const Setting &element, const string &name, SettingPresence settingPresence=optional)" --> |
| 245 | <div class="memitem"> |
| 246 | <div class="memproto"> |
| 247 | <div class="memtemplate"> |
| 248 | template<class T > </div> |
| 249 | <table class="memname"> |
| 250 | <tr> |
| 251 | <td class="memname">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a><T> bdm::UI::build </td> |
249 | | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
250 | | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
251 | | </tr> |
252 | | <tr> |
253 | | <td></td> |
254 | | <td>)</td> |
255 | | <td></td><td></td><td><code> [inline, static]</code></td> |
256 | | </tr> |
257 | | </table> |
258 | | </div> |
259 | | <div class="memdoc"> |
260 | | <p>The new instance of type T* is constructed and initialized with values stored in the Setting element[name]</p> |
261 | | <p>If there is not any sub-element named name and settingPresence is optional, an empty shared_ptr<T> is returned. When settingPresence is compulsory, the returned shared_ptr<T> is never empty (an exception is thrown when the object isn't found). </p> |
262 | | |
263 | | </div> |
264 | | </div> |
265 | | <a class="anchor" id="a29e450ed5560f81ef2f845e7b1021b71"></a><!-- doxytag: member="bdm::UI::get" ref="a29e450ed5560f81ef2f845e7b1021b71" args="(Array< T > &array_to_load, const Setting &element, const int index, SettingPresence settingPresence=optional)" --> |
266 | | <div class="memitem"> |
267 | | <div class="memproto"> |
268 | | <div class="memtemplate"> |
269 | | template<class T > </div> |
270 | | <table class="memname"> |
271 | | <tr> |
272 | | <td class="memname">static bool bdm::UI::get </td> |
| 265 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
| 266 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
| 267 | </tr> |
| 268 | <tr> |
| 269 | <td></td> |
| 270 | <td>)</td> |
| 271 | <td></td><td></td><td><code> [inline, static]</code></td> |
| 272 | </tr> |
| 273 | </table> |
| 274 | </div> |
| 275 | <div class="memdoc"> |
| 276 | |
| 277 | <p> |
| 278 | The new instance of type T* is constructed and initialized with values stored in the Setting element[name]<p> |
| 279 | If there is not any sub-element named name and settingPresence is optional, an empty <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr<T></a> is returned. When settingPresence is compulsory, the returned <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr<T></a> is never empty (an exception is thrown when the object isn't found). |
| 280 | </div> |
| 281 | </div><p> |
| 282 | <a class="anchor" name="29e450ed5560f81ef2f845e7b1021b71"></a><!-- doxytag: member="bdm::UI::get" ref="29e450ed5560f81ef2f845e7b1021b71" args="(Array< T > &array_to_load, const Setting &element, const int index, SettingPresence settingPresence=optional)" --> |
| 283 | <div class="memitem"> |
| 284 | <div class="memproto"> |
| 285 | <div class="memtemplate"> |
| 286 | template<class T > </div> |
| 287 | <table class="memname"> |
| 288 | <tr> |
| 289 | <td class="memname">static bool bdm::UI::get </td> |
292 | | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
293 | | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
294 | | </tr> |
295 | | <tr> |
296 | | <td></td> |
297 | | <td>)</td> |
298 | | <td></td><td></td><td><code> [inline, static]</code></td> |
299 | | </tr> |
300 | | </table> |
301 | | </div> |
302 | | <div class="memdoc"> |
303 | | <p>The existing array of type T is initialized with values stored in the Setting element[index] If there is not any sub-element indexed by index, this method returns false. </p> |
304 | | |
305 | | </div> |
306 | | </div> |
307 | | <a class="anchor" id="a81ce18ed0bb9993a634db2b99612ad66"></a><!-- doxytag: member="bdm::UI::get" ref="a81ce18ed0bb9993a634db2b99612ad66" args="(Array< T > &array_to_load, const Setting &element, const string &name, SettingPresence settingPresence=optional)" --> |
308 | | <div class="memitem"> |
309 | | <div class="memproto"> |
310 | | <div class="memtemplate"> |
311 | | template<class T > </div> |
312 | | <table class="memname"> |
313 | | <tr> |
314 | | <td class="memname">static bool bdm::UI::get </td> |
| 309 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
| 310 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
| 311 | </tr> |
| 312 | <tr> |
| 313 | <td></td> |
| 314 | <td>)</td> |
| 315 | <td></td><td></td><td><code> [inline, static]</code></td> |
| 316 | </tr> |
| 317 | </table> |
| 318 | </div> |
| 319 | <div class="memdoc"> |
| 320 | |
| 321 | <p> |
| 322 | The existing array of type T is initialized with values stored in the Setting element[index] If there is not any sub-element indexed by index, this method returns false. |
| 323 | </div> |
| 324 | </div><p> |
| 325 | <a class="anchor" name="81ce18ed0bb9993a634db2b99612ad66"></a><!-- doxytag: member="bdm::UI::get" ref="81ce18ed0bb9993a634db2b99612ad66" args="(Array< T > &array_to_load, const Setting &element, const string &name, SettingPresence settingPresence=optional)" --> |
| 326 | <div class="memitem"> |
| 327 | <div class="memproto"> |
| 328 | <div class="memtemplate"> |
| 329 | template<class T > </div> |
| 330 | <table class="memname"> |
| 331 | <tr> |
| 332 | <td class="memname">static bool bdm::UI::get </td> |
334 | | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
335 | | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
336 | | </tr> |
337 | | <tr> |
338 | | <td></td> |
339 | | <td>)</td> |
340 | | <td></td><td></td><td><code> [inline, static]</code></td> |
341 | | </tr> |
342 | | </table> |
343 | | </div> |
344 | | <div class="memdoc"> |
345 | | <p>The existing array of type T is initialized with values stored in the Setting element[name] If there is not any sub-element named name, this method returns false. </p> |
346 | | |
347 | | </div> |
348 | | </div> |
349 | | <a class="anchor" id="a6fb95ccb13515a3f23080a397dacaa0e"></a><!-- doxytag: member="bdm::UI::get" ref="a6fb95ccb13515a3f23080a397dacaa0e" args="(T &instance, const Setting &element, const int index, SettingPresence settingPresence=optional)" --> |
350 | | <div class="memitem"> |
351 | | <div class="memproto"> |
352 | | <div class="memtemplate"> |
353 | | template<class T > </div> |
354 | | <table class="memname"> |
355 | | <tr> |
356 | | <td class="memname">static bool bdm::UI::get </td> |
| 352 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
| 353 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
| 354 | </tr> |
| 355 | <tr> |
| 356 | <td></td> |
| 357 | <td>)</td> |
| 358 | <td></td><td></td><td><code> [inline, static]</code></td> |
| 359 | </tr> |
| 360 | </table> |
| 361 | </div> |
| 362 | <div class="memdoc"> |
| 363 | |
| 364 | <p> |
| 365 | The existing array of type T is initialized with values stored in the Setting element[name] If there is not any sub-element named name, this method returns false. |
| 366 | </div> |
| 367 | </div><p> |
| 368 | <a class="anchor" name="6fb95ccb13515a3f23080a397dacaa0e"></a><!-- doxytag: member="bdm::UI::get" ref="6fb95ccb13515a3f23080a397dacaa0e" args="(T &instance, const Setting &element, const int index, SettingPresence settingPresence=optional)" --> |
| 369 | <div class="memitem"> |
| 370 | <div class="memproto"> |
| 371 | <div class="memtemplate"> |
| 372 | template<class T > </div> |
| 373 | <table class="memname"> |
| 374 | <tr> |
| 375 | <td class="memname">static bool bdm::UI::get </td> |
376 | | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
377 | | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
378 | | </tr> |
379 | | <tr> |
380 | | <td></td> |
381 | | <td>)</td> |
382 | | <td></td><td></td><td><code> [inline, static]</code></td> |
383 | | </tr> |
384 | | </table> |
385 | | </div> |
386 | | <div class="memdoc"> |
387 | | <p>The existing instance of type T is initialized with values stored in the Setting element[index] If there is not any sub-element indexed by index, this method returns false. </p> |
388 | | |
389 | | </div> |
390 | | </div> |
391 | | <a class="anchor" id="acd1667e6fec99ec64dabcb3ca2ff922d"></a><!-- doxytag: member="bdm::UI::get" ref="acd1667e6fec99ec64dabcb3ca2ff922d" args="(T &instance, const Setting &element, const string &name, SettingPresence settingPresence=optional)" --> |
392 | | <div class="memitem"> |
393 | | <div class="memproto"> |
394 | | <div class="memtemplate"> |
395 | | template<class T > </div> |
396 | | <table class="memname"> |
397 | | <tr> |
398 | | <td class="memname">static bool bdm::UI::get </td> |
| 395 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
| 396 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
| 397 | </tr> |
| 398 | <tr> |
| 399 | <td></td> |
| 400 | <td>)</td> |
| 401 | <td></td><td></td><td><code> [inline, static]</code></td> |
| 402 | </tr> |
| 403 | </table> |
| 404 | </div> |
| 405 | <div class="memdoc"> |
| 406 | |
| 407 | <p> |
| 408 | The existing instance of type T is initialized with values stored in the Setting element[index] If there is not any sub-element indexed by index, this method returns false. |
| 409 | </div> |
| 410 | </div><p> |
| 411 | <a class="anchor" name="cd1667e6fec99ec64dabcb3ca2ff922d"></a><!-- doxytag: member="bdm::UI::get" ref="cd1667e6fec99ec64dabcb3ca2ff922d" args="(T &instance, const Setting &element, const string &name, SettingPresence settingPresence=optional)" --> |
| 412 | <div class="memitem"> |
| 413 | <div class="memproto"> |
| 414 | <div class="memtemplate"> |
| 415 | template<class T > </div> |
| 416 | <table class="memname"> |
| 417 | <tr> |
| 418 | <td class="memname">static bool bdm::UI::get </td> |
418 | | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
419 | | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
420 | | </tr> |
421 | | <tr> |
422 | | <td></td> |
423 | | <td>)</td> |
424 | | <td></td><td></td><td><code> [inline, static]</code></td> |
425 | | </tr> |
426 | | </table> |
427 | | </div> |
428 | | <div class="memdoc"> |
429 | | <p>The existing instance of type T is initialized with values stored in the Setting element[name] If there is not any sub-element named name, this method returns false. </p> |
430 | | |
431 | | <p>Referenced by <a class="el" href="particles_8h_source.html#l00344">bdm::MPF::from_setting()</a>, <a class="el" href="mex__datasource_8h_source.html#l00103">bdm::mexDS::from_setting()</a>, <a class="el" href="merger_8h_source.html#l00262">bdm::merger_base::from_setting()</a>, <a class="el" href="kalman_8h_source.html#l00124">bdm::Kalman< fsqmat >::from_setting()</a>, <a class="el" href="kalman_8h_source.html#l00059">bdm::StateSpace< fsqmat >::from_setting()</a>, <a class="el" href="kalman_8cpp_source.html#l00276">bdm::MultiModel::from_setting()</a>, <a class="el" href="kalman_8cpp_source.html#l00240">bdm::EKFCh::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l01322">bdm::enorm< sq_T >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00856">bdm::mgamma::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00747">bdm::mgnorm< sq_T >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00690">bdm::mlnorm< chmat >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00617">bdm::euni::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00505">bdm::egamma::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00380">bdm::mDirich::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00334">bdm::eDirich::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00260">bdm::egiw::from_setting()</a>, <a class="el" href="exp__family_8cpp_source.html#l00375">bdm::mlognorm::from_setting()</a>, <a class="el" href="exp__family_8cpp_source.html#l00369">bdm::migamma_ref::from_setting()</a>, <a class="el" href="emix_8h_source.html#l00361">bdm::mprod::from_setting()</a>, <a class="el" href="discrete_8h_source.html#l00174">bdm::discrete_support::from_setting()</a>, <a class="el" href="discrete_8h_source.html#l00140">bdm::rectangular_support::from_setting()</a>, <a class="el" href="datasources_8h_source.html#l00186">bdm::MpdfDS::from_setting()</a>, <a class="el" href="datasources_8h_source.html#l00080">bdm::MemDS::from_setting()</a>, <a class="el" href="datasources_8cpp_source.html#l00057">bdm::ArxDS::from_setting()</a>, <a class="el" href="ctrlbase_8h_source.html#l00132">bdm::Controller::from_setting()</a>, <a class="el" href="bdmbase_8h_source.html#l01205">bdm::BM::from_setting()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00353">bdm::RV::from_setting()</a>, <a class="el" href="arx_8cpp_source.html#l00214">bdm::ARX::from_setting()</a>, <a class="el" href="arx__ctrl_8h_source.html#l00055">bdm::LQG_ARX::from_settings()</a>, <a class="el" href="particles_8h_source.html#l00166">bdm::PF::prior_from_set()</a>, and <a class="el" href="particles_8h_source.html#l00142">bdm::PF::resmethod_from_set()</a>.</p> |
432 | | |
433 | | </div> |
434 | | </div> |
435 | | <hr/>The documentation for this class was generated from the following files:<ul> |
436 | | <li><a class="el" href="user__info_8h_source.html">user_info.h</a></li> |
437 | | <li>user_info.cpp</li> |
438 | | </ul> |
439 | | </div> |
440 | | <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 27 00:49:05 2009 for mixpp by |
| 438 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
| 439 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
| 440 | </tr> |
| 441 | <tr> |
| 442 | <td></td> |
| 443 | <td>)</td> |
| 444 | <td></td><td></td><td><code> [inline, static]</code></td> |
| 445 | </tr> |
| 446 | </table> |
| 447 | </div> |
| 448 | <div class="memdoc"> |
| 449 | |
| 450 | <p> |
| 451 | The existing instance of type T is initialized with values stored in the Setting element[name] If there is not any sub-element named name, this method returns false. |
| 452 | <p>Referenced by <a class="el" href="particles_8h_source.html#l00344">bdm::MPF::from_setting()</a>, <a class="el" href="mex__datasource_8h_source.html#l00103">bdm::mexDS::from_setting()</a>, <a class="el" href="merger_8h_source.html#l00262">bdm::merger_base::from_setting()</a>, <a class="el" href="kalman_8h_source.html#l00124">bdm::Kalman< fsqmat >::from_setting()</a>, <a class="el" href="kalman_8h_source.html#l00059">bdm::StateSpace< sq_T >::from_setting()</a>, <a class="el" href="kalman_8cpp_source.html#l00276">bdm::MultiModel::from_setting()</a>, <a class="el" href="kalman_8cpp_source.html#l00240">bdm::EKFCh::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l01323">bdm::enorm< sq_T >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00857">bdm::mgamma::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00748">bdm::mgnorm< sq_T >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00691">bdm::mlnorm< ldmat, enorm >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00618">bdm::euni::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00506">bdm::egamma::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00381">bdm::mDirich::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00335">bdm::eDirich::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00260">bdm::egiw::from_setting()</a>, <a class="el" href="exp__family_8cpp_source.html#l00375">bdm::mlognorm::from_setting()</a>, <a class="el" href="exp__family_8cpp_source.html#l00369">bdm::migamma_ref::from_setting()</a>, <a class="el" href="emix_8h_source.html#l00361">bdm::mprod::from_setting()</a>, <a class="el" href="discrete_8cpp_source.html#l00098">bdm::discrete_support::from_setting()</a>, <a class="el" href="discrete_8cpp_source.html#l00090">bdm::rectangular_support::from_setting()</a>, <a class="el" href="datasources_8h_source.html#l00186">bdm::MpdfDS::from_setting()</a>, <a class="el" href="datasources_8h_source.html#l00080">bdm::MemDS::from_setting()</a>, <a class="el" href="datasources_8cpp_source.html#l00057">bdm::ArxDS::from_setting()</a>, <a class="el" href="ctrlbase_8h_source.html#l00135">bdm::Controller::from_setting()</a>, <a class="el" href="bdmbase_8h_source.html#l01205">bdm::BM::from_setting()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00353">bdm::RV::from_setting()</a>, <a class="el" href="arx_8cpp_source.html#l00214">bdm::ARX::from_setting()</a>, <a class="el" href="particles_8h_source.html#l00166">bdm::PF::prior_from_set()</a>, and <a class="el" href="particles_8h_source.html#l00142">bdm::PF::resmethod_from_set()</a>.</p> |
| 453 | |
| 454 | </div> |
| 455 | </div><p> |
| 456 | <hr>The documentation for this class was generated from the following files:<ul> |
| 457 | <li><a class="el" href="user__info_8h_source.html">user_info.h</a><li>user_info.cpp</ul> |
| 458 | </div> |
| 459 | <hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by |