1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
---|
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
---|
3 | <title>mixpp: bdm::UI Class Reference</title> |
---|
4 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
---|
5 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
---|
6 | </head><body> |
---|
7 | <!-- Generated by Doxygen 1.5.9 --> |
---|
8 | <script type="text/javascript"> |
---|
9 | <!-- |
---|
10 | function changeDisplayState (e){ |
---|
11 | var num=this.id.replace(/[^[0-9]/g,''); |
---|
12 | var button=this.firstChild; |
---|
13 | var sectionDiv=document.getElementById('dynsection'+num); |
---|
14 | if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){ |
---|
15 | sectionDiv.style.display='block'; |
---|
16 | button.src='open.gif'; |
---|
17 | }else{ |
---|
18 | sectionDiv.style.display='none'; |
---|
19 | button.src='closed.gif'; |
---|
20 | } |
---|
21 | } |
---|
22 | function initDynSections(){ |
---|
23 | var divs=document.getElementsByTagName('div'); |
---|
24 | var sectionCounter=1; |
---|
25 | for(var i=0;i<divs.length-1;i++){ |
---|
26 | if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){ |
---|
27 | var header=divs[i]; |
---|
28 | var section=divs[i+1]; |
---|
29 | var button=header.firstChild; |
---|
30 | if (button!='IMG'){ |
---|
31 | divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild); |
---|
32 | button=document.createElement('img'); |
---|
33 | divs[i].insertBefore(button,divs[i].firstChild); |
---|
34 | } |
---|
35 | header.style.cursor='pointer'; |
---|
36 | header.onclick=changeDisplayState; |
---|
37 | header.id='dynheader'+sectionCounter; |
---|
38 | button.src='closed.gif'; |
---|
39 | section.id='dynsection'+sectionCounter; |
---|
40 | section.style.display='none'; |
---|
41 | section.style.marginLeft='14px'; |
---|
42 | sectionCounter++; |
---|
43 | } |
---|
44 | } |
---|
45 | } |
---|
46 | window.onload = initDynSections; |
---|
47 | --> |
---|
48 | </script> |
---|
49 | <div class="navigation" id="top"> |
---|
50 | <div class="tabs"> |
---|
51 | <ul> |
---|
52 | <li><a href="main.html"><span>Main Page</span></a></li> |
---|
53 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
---|
54 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
---|
55 | <li><a href="files.html"><span>Files</span></a></li> |
---|
56 | </ul> |
---|
57 | </div> |
---|
58 | <div class="tabs"> |
---|
59 | <ul> |
---|
60 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
61 | <li><a href="classes.html"><span>Class Index</span></a></li> |
---|
62 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
63 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
64 | </ul> |
---|
65 | </div> |
---|
66 | <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1UI.html">UI</a> |
---|
67 | </div> |
---|
68 | </div> |
---|
69 | <div class="contents"> |
---|
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>, |
---|
84 | <b>compulsory</b> |
---|
85 | }</td></tr> |
---|
86 | |
---|
87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enumerical type used to determine whether the data for concrete Settingis is compulsory or optional. <br></td></tr> |
---|
88 | <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> |
---|
89 | <tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr> |
---|
90 | <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> |
---|
91 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
---|
92 | <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> |
---|
93 | |
---|
94 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
---|
95 | <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> |
---|
96 | |
---|
97 | <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="6e2da6a142fecf5f21e0bb86a7211cb4"></a><!-- doxytag: member="bdm::UI::build" ref="6e2da6a142fecf5f21e0bb86a7211cb4" args="(const Setting &element)" --> |
---|
98 | template<class T > </td></tr> |
---|
99 | <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> |
---|
100 | |
---|
101 | <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> |
---|
102 | <tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr> |
---|
103 | <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> |
---|
104 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
---|
105 | <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> |
---|
106 | |
---|
107 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
---|
108 | <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> |
---|
109 | |
---|
110 | <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)" --> |
---|
111 | template<class T > </td></tr> |
---|
112 | <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#7d2ea138c7285565507fa61fbd9b038f">get</a> (T &instance, const Setting &element)</td></tr> |
---|
113 | |
---|
114 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element directly. <br></td></tr> |
---|
115 | <tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array<T></div></td></tr> |
---|
116 | <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> |
---|
117 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
---|
118 | <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> |
---|
119 | |
---|
120 | <tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr> |
---|
121 | <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> |
---|
122 | |
---|
123 | <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)" --> |
---|
124 | template<class T > </td></tr> |
---|
125 | <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#c9fad8376d2f0857e719511f92f93998">get</a> (Array< T > &array_to_load, const Setting &element)</td></tr> |
---|
126 | |
---|
127 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element. <br></td></tr> |
---|
128 | <tr><td colspan="2"><div class="groupHeader">Serialization of objects and structures into a new Setting</div></td></tr> |
---|
129 | <tr><td colspan="2"><div class="groupText">The new child Setting can be accessed either by its name - if some name is passed as a parameter - or by its integer index. In that case, the new element is added at the very end of the current list of child Settings. <br><br></div></td></tr> |
---|
130 | <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c83987949e6a9e79d6e093797ab7d917"></a><!-- doxytag: member="bdm::UI::save" ref="c83987949e6a9e79d6e093797ab7d917" args="(const T *const instance, Setting &element, const string &name="")" --> |
---|
131 | template<class T > </td></tr> |
---|
132 | <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#c83987949e6a9e79d6e093797ab7d917">save</a> (const T *const instance, Setting &element, const string &name="")</td></tr> |
---|
133 | |
---|
134 | <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> |
---|
135 | <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4514f93573a9d9126c506d176fbd3163"></a><!-- doxytag: member="bdm::UI::save" ref="4514f93573a9d9126c506d176fbd3163" args="(const Array< T > &array_to_save, Setting &element, const string &name="")" --> |
---|
136 | template<class T > </td></tr> |
---|
137 | <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> |
---|
138 | |
---|
139 | <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> |
---|
140 | <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="")" --> |
---|
141 | 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> |
---|
142 | |
---|
143 | <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> |
---|
144 | <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="")" --> |
---|
145 | 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> |
---|
146 | |
---|
147 | <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> |
---|
148 | <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="")" --> |
---|
149 | 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> |
---|
150 | |
---|
151 | <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> |
---|
152 | <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="")" --> |
---|
153 | 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> |
---|
154 | |
---|
155 | <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> |
---|
156 | <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="")" --> |
---|
157 | 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> |
---|
158 | |
---|
159 | <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> |
---|
160 | <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="")" --> |
---|
161 | 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> |
---|
162 | |
---|
163 | <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> |
---|
164 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
165 | <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> |
---|
166 | |
---|
167 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor for internal use only, see. <a href="#d60234c0673f345424329894b9b0cef8"></a><br></td></tr> |
---|
168 | </table> |
---|
169 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
170 | <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. |
---|
171 | <p> |
---|
172 | 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> |
---|
173 | <a class="el" href="ui_page.html">User Infos and their use</a> <hr><h2>Constructor & Destructor Documentation</h2> |
---|
174 | <a class="anchor" name="d60234c0673f345424329894b9b0cef8"></a><!-- doxytag: member="bdm::UI::UI" ref="d60234c0673f345424329894b9b0cef8" args="(const string &class_name, const type_info *const class_type_info)" --> |
---|
175 | <div class="memitem"> |
---|
176 | <div class="memproto"> |
---|
177 | <table class="memname"> |
---|
178 | <tr> |
---|
179 | <td class="memname">bdm::UI::UI </td> |
---|
180 | <td>(</td> |
---|
181 | <td class="paramtype">const string & </td> |
---|
182 | <td class="paramname"> <em>class_name</em>, </td> |
---|
183 | </tr> |
---|
184 | <tr> |
---|
185 | <td class="paramkey"></td> |
---|
186 | <td></td> |
---|
187 | <td class="paramtype">const type_info *const </td> |
---|
188 | <td class="paramname"> <em>class_type_info</em></td><td> </td> |
---|
189 | </tr> |
---|
190 | <tr> |
---|
191 | <td></td> |
---|
192 | <td>)</td> |
---|
193 | <td></td><td></td><td><code> [inline, protected]</code></td> |
---|
194 | </tr> |
---|
195 | </table> |
---|
196 | </div> |
---|
197 | <div class="memdoc"> |
---|
198 | |
---|
199 | <p> |
---|
200 | Default constructor for internal use only, see. |
---|
201 | <p> |
---|
202 | <dl class="see" compact><dt><b>See also:</b></dt><dd>ParticularUI<T> </dd></dl> |
---|
203 | |
---|
204 | </div> |
---|
205 | </div><p> |
---|
206 | <hr><h2>Member Function Documentation</h2> |
---|
207 | <a class="anchor" name="b8b2512d4762463cbf23314d45f1c5b1"></a><!-- doxytag: member="bdm::UI::build" ref="b8b2512d4762463cbf23314d45f1c5b1" args="(const Setting &element, const int index, SettingPresence settingPresence=optional)" --> |
---|
208 | <div class="memitem"> |
---|
209 | <div class="memproto"> |
---|
210 | <div class="memtemplate"> |
---|
211 | template<class T > </div> |
---|
212 | <table class="memname"> |
---|
213 | <tr> |
---|
214 | <td class="memname">static T* bdm::UI::build </td> |
---|
215 | <td>(</td> |
---|
216 | <td class="paramtype">const Setting & </td> |
---|
217 | <td class="paramname"> <em>element</em>, </td> |
---|
218 | </tr> |
---|
219 | <tr> |
---|
220 | <td class="paramkey"></td> |
---|
221 | <td></td> |
---|
222 | <td class="paramtype">const int </td> |
---|
223 | <td class="paramname"> <em>index</em>, </td> |
---|
224 | </tr> |
---|
225 | <tr> |
---|
226 | <td class="paramkey"></td> |
---|
227 | <td></td> |
---|
228 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
---|
229 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
---|
230 | </tr> |
---|
231 | <tr> |
---|
232 | <td></td> |
---|
233 | <td>)</td> |
---|
234 | <td></td><td></td><td><code> [inline, static]</code></td> |
---|
235 | </tr> |
---|
236 | </table> |
---|
237 | </div> |
---|
238 | <div class="memdoc"> |
---|
239 | |
---|
240 | <p> |
---|
241 | The new instance of type T* is constructed and initialized with values stored in the Setting element[index]<p> |
---|
242 | If there is not any sub-element indexed by index, the null pointer is returned. |
---|
243 | </div> |
---|
244 | </div><p> |
---|
245 | <a class="anchor" name="970297d6c758692135877dfa7a5eacb0"></a><!-- doxytag: member="bdm::UI::build" ref="970297d6c758692135877dfa7a5eacb0" args="(const Setting &element, const string &name, SettingPresence settingPresence=optional)" --> |
---|
246 | <div class="memitem"> |
---|
247 | <div class="memproto"> |
---|
248 | <div class="memtemplate"> |
---|
249 | template<class T > </div> |
---|
250 | <table class="memname"> |
---|
251 | <tr> |
---|
252 | <td class="memname">static T* bdm::UI::build </td> |
---|
253 | <td>(</td> |
---|
254 | <td class="paramtype">const Setting & </td> |
---|
255 | <td class="paramname"> <em>element</em>, </td> |
---|
256 | </tr> |
---|
257 | <tr> |
---|
258 | <td class="paramkey"></td> |
---|
259 | <td></td> |
---|
260 | <td class="paramtype">const string & </td> |
---|
261 | <td class="paramname"> <em>name</em>, </td> |
---|
262 | </tr> |
---|
263 | <tr> |
---|
264 | <td class="paramkey"></td> |
---|
265 | <td></td> |
---|
266 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
---|
267 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
---|
268 | </tr> |
---|
269 | <tr> |
---|
270 | <td></td> |
---|
271 | <td>)</td> |
---|
272 | <td></td><td></td><td><code> [inline, static]</code></td> |
---|
273 | </tr> |
---|
274 | </table> |
---|
275 | </div> |
---|
276 | <div class="memdoc"> |
---|
277 | |
---|
278 | <p> |
---|
279 | The new instance of type T* is constructed and initialized with values stored in the Setting element[name]<p> |
---|
280 | If there is not any sub-element named name, the null pointer is returned. |
---|
281 | </div> |
---|
282 | </div><p> |
---|
283 | <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)" --> |
---|
284 | <div class="memitem"> |
---|
285 | <div class="memproto"> |
---|
286 | <div class="memtemplate"> |
---|
287 | template<class T > </div> |
---|
288 | <table class="memname"> |
---|
289 | <tr> |
---|
290 | <td class="memname">static bool bdm::UI::get </td> |
---|
291 | <td>(</td> |
---|
292 | <td class="paramtype">Array< T > & </td> |
---|
293 | <td class="paramname"> <em>array_to_load</em>, </td> |
---|
294 | </tr> |
---|
295 | <tr> |
---|
296 | <td class="paramkey"></td> |
---|
297 | <td></td> |
---|
298 | <td class="paramtype">const Setting & </td> |
---|
299 | <td class="paramname"> <em>element</em>, </td> |
---|
300 | </tr> |
---|
301 | <tr> |
---|
302 | <td class="paramkey"></td> |
---|
303 | <td></td> |
---|
304 | <td class="paramtype">const int </td> |
---|
305 | <td class="paramname"> <em>index</em>, </td> |
---|
306 | </tr> |
---|
307 | <tr> |
---|
308 | <td class="paramkey"></td> |
---|
309 | <td></td> |
---|
310 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
---|
311 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
---|
312 | </tr> |
---|
313 | <tr> |
---|
314 | <td></td> |
---|
315 | <td>)</td> |
---|
316 | <td></td><td></td><td><code> [inline, static]</code></td> |
---|
317 | </tr> |
---|
318 | </table> |
---|
319 | </div> |
---|
320 | <div class="memdoc"> |
---|
321 | |
---|
322 | <p> |
---|
323 | 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. |
---|
324 | </div> |
---|
325 | </div><p> |
---|
326 | <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)" --> |
---|
327 | <div class="memitem"> |
---|
328 | <div class="memproto"> |
---|
329 | <div class="memtemplate"> |
---|
330 | template<class T > </div> |
---|
331 | <table class="memname"> |
---|
332 | <tr> |
---|
333 | <td class="memname">static bool bdm::UI::get </td> |
---|
334 | <td>(</td> |
---|
335 | <td class="paramtype">Array< T > & </td> |
---|
336 | <td class="paramname"> <em>array_to_load</em>, </td> |
---|
337 | </tr> |
---|
338 | <tr> |
---|
339 | <td class="paramkey"></td> |
---|
340 | <td></td> |
---|
341 | <td class="paramtype">const Setting & </td> |
---|
342 | <td class="paramname"> <em>element</em>, </td> |
---|
343 | </tr> |
---|
344 | <tr> |
---|
345 | <td class="paramkey"></td> |
---|
346 | <td></td> |
---|
347 | <td class="paramtype">const string & </td> |
---|
348 | <td class="paramname"> <em>name</em>, </td> |
---|
349 | </tr> |
---|
350 | <tr> |
---|
351 | <td class="paramkey"></td> |
---|
352 | <td></td> |
---|
353 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
---|
354 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
---|
355 | </tr> |
---|
356 | <tr> |
---|
357 | <td></td> |
---|
358 | <td>)</td> |
---|
359 | <td></td><td></td><td><code> [inline, static]</code></td> |
---|
360 | </tr> |
---|
361 | </table> |
---|
362 | </div> |
---|
363 | <div class="memdoc"> |
---|
364 | |
---|
365 | <p> |
---|
366 | 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. |
---|
367 | </div> |
---|
368 | </div><p> |
---|
369 | <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)" --> |
---|
370 | <div class="memitem"> |
---|
371 | <div class="memproto"> |
---|
372 | <div class="memtemplate"> |
---|
373 | template<class T > </div> |
---|
374 | <table class="memname"> |
---|
375 | <tr> |
---|
376 | <td class="memname">static bool bdm::UI::get </td> |
---|
377 | <td>(</td> |
---|
378 | <td class="paramtype">T & </td> |
---|
379 | <td class="paramname"> <em>instance</em>, </td> |
---|
380 | </tr> |
---|
381 | <tr> |
---|
382 | <td class="paramkey"></td> |
---|
383 | <td></td> |
---|
384 | <td class="paramtype">const Setting & </td> |
---|
385 | <td class="paramname"> <em>element</em>, </td> |
---|
386 | </tr> |
---|
387 | <tr> |
---|
388 | <td class="paramkey"></td> |
---|
389 | <td></td> |
---|
390 | <td class="paramtype">const int </td> |
---|
391 | <td class="paramname"> <em>index</em>, </td> |
---|
392 | </tr> |
---|
393 | <tr> |
---|
394 | <td class="paramkey"></td> |
---|
395 | <td></td> |
---|
396 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
---|
397 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
---|
398 | </tr> |
---|
399 | <tr> |
---|
400 | <td></td> |
---|
401 | <td>)</td> |
---|
402 | <td></td><td></td><td><code> [inline, static]</code></td> |
---|
403 | </tr> |
---|
404 | </table> |
---|
405 | </div> |
---|
406 | <div class="memdoc"> |
---|
407 | |
---|
408 | <p> |
---|
409 | 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. |
---|
410 | </div> |
---|
411 | </div><p> |
---|
412 | <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)" --> |
---|
413 | <div class="memitem"> |
---|
414 | <div class="memproto"> |
---|
415 | <div class="memtemplate"> |
---|
416 | template<class T > </div> |
---|
417 | <table class="memname"> |
---|
418 | <tr> |
---|
419 | <td class="memname">static bool bdm::UI::get </td> |
---|
420 | <td>(</td> |
---|
421 | <td class="paramtype">T & </td> |
---|
422 | <td class="paramname"> <em>instance</em>, </td> |
---|
423 | </tr> |
---|
424 | <tr> |
---|
425 | <td class="paramkey"></td> |
---|
426 | <td></td> |
---|
427 | <td class="paramtype">const Setting & </td> |
---|
428 | <td class="paramname"> <em>element</em>, </td> |
---|
429 | </tr> |
---|
430 | <tr> |
---|
431 | <td class="paramkey"></td> |
---|
432 | <td></td> |
---|
433 | <td class="paramtype">const string & </td> |
---|
434 | <td class="paramname"> <em>name</em>, </td> |
---|
435 | </tr> |
---|
436 | <tr> |
---|
437 | <td class="paramkey"></td> |
---|
438 | <td></td> |
---|
439 | <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td> |
---|
440 | <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td> |
---|
441 | </tr> |
---|
442 | <tr> |
---|
443 | <td></td> |
---|
444 | <td>)</td> |
---|
445 | <td></td><td></td><td><code> [inline, static]</code></td> |
---|
446 | </tr> |
---|
447 | </table> |
---|
448 | </div> |
---|
449 | <div class="memdoc"> |
---|
450 | |
---|
451 | <p> |
---|
452 | 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. |
---|
453 | <p>Referenced by <a class="el" href="merger_8h_source.html#l00273">bdm::merger_base::from_setting()</a>, <a class="el" href="kalman_8cpp_source.html#l00289">bdm::MultiModel::from_setting()</a>, <a class="el" href="kalman_8cpp_source.html#l00252">bdm::EKFCh::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l01203">bdm::enorm< sq_T >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00727">bdm::mgamma::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00623">bdm::mgnorm< sq_T >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00565">bdm::mlnorm< ldmat >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00517">bdm::euni::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00404">bdm::egamma::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00236">bdm::egiw::from_setting()</a>, <a class="el" href="exp__family_8cpp_source.html#l00331">bdm::mlognorm::from_setting()</a>, <a class="el" href="exp__family_8cpp_source.html#l00324">bdm::migamma_ref::from_setting()</a>, <a class="el" href="emix_8h_source.html#l00329">bdm::mprod::from_setting()</a>, <a class="el" href="datasources_8cpp_source.html#l00056">bdm::ArxDS::from_setting()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00280">bdm::RV::from_setting()</a>, and <a class="el" href="arx_8cpp_source.html#l00196">bdm::ARX::from_setting()</a>.</p> |
---|
454 | |
---|
455 | </div> |
---|
456 | </div><p> |
---|
457 | <hr>The documentation for this class was generated from the following files:<ul> |
---|
458 | <li><a class="el" href="user__info_8h_source.html">user_info.h</a><li>user_info.cpp</ul> |
---|
459 | </div> |
---|
460 | <hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:06:56 2009 for mixpp by |
---|
461 | <a href="http://www.doxygen.org/index.html"> |
---|
462 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
---|
463 | </body> |
---|
464 | </html> |
---|