root/library/doc/html/classbdm_1_1UI.html @ 590

Revision 590, 31.2 kB (checked in by smidl, 16 years ago)

doc

Line 
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.8 -->
8<script type="text/javascript">
9<!--
10function 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}
22function 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}
46window.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&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;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 &lt;<a class="el" href="user__info_8h-source.html">user_info.h</a>&gt;</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 &nbsp;</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 &nbsp;</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">&nbsp;</td><td class="mdescRight">Enum 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&lt;class T &gt; </td></tr>
92<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#1f3d45184f803e1256cfc896b43ed2f8">build</a> (const Setting &amp;element, const string &amp;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&lt;class T &gt; </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>&lt; T &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#f02851b299aedeb891e30c4807903081">build</a> (const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
96
97<tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr>
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&lt;class T &gt; </td></tr>
100<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cd1667e6fec99ec64dabcb3ca2ff922d">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;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&lt;class T &gt; </td></tr>
103<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#6fb95ccb13515a3f23080a397dacaa0e">get</a> (T &amp;instance, const Setting &amp;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 &amp;instance, const Setting &amp;element)" -->
106template&lt;class T &gt; </td></tr>
107<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7d2ea138c7285565507fa61fbd9b038f">get</a> (T &amp;instance, const Setting &amp;element)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element directly. <br></td></tr>
110<tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array&lt;T&gt;</div></td></tr>
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&lt;class T &gt; </td></tr>
113<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#81ce18ed0bb9993a634db2b99612ad66">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;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&lt;class T &gt; </td></tr>
116<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#29e450ed5560f81ef2f845e7b1021b71">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;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&lt; T &gt; &amp;array_to_load, const Setting &amp;element)" -->
119template&lt;class T &gt; </td></tr>
120<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#c9fad8376d2f0857e719511f92f93998">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)</td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element. <br></td></tr>
123<tr><td colspan="2"><div class="groupHeader">Serialization of objects and structures into a new Setting</div></td></tr>
124<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>
125<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 &amp;element, const string &amp;name=&quot;&quot;)" -->
126template&lt;class T &gt; </td></tr>
127<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#c83987949e6a9e79d6e093797ab7d917">save</a> (const T *const instance, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</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>
130<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7a307cd313e516b6d5629046dd321039"></a><!-- doxytag: member="bdm::UI::save" ref="7a307cd313e516b6d5629046dd321039" args="(const shared_ptr&lt; T &gt; &amp;instance, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
131template&lt;class T &gt; </td></tr>
132<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>save</b> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt; &amp;instance, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
133
134<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4514f93573a9d9126c506d176fbd3163"></a><!-- doxytag: member="bdm::UI::save" ref="4514f93573a9d9126c506d176fbd3163" args="(const Array&lt; T &gt; &amp;array_to_save, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
135template&lt;class T &gt; </td></tr>
136<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#4514f93573a9d9126c506d176fbd3163">save</a> (const Array&lt; T &gt; &amp;array_to_save, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An Array&lt;T&gt; 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 &amp;matrix, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
140static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#42e908a4f1b09d701be69c8784a02df7">save</a> (const mat &amp;matrix, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</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 &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
144static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cc2afb61a772d8571f7bb19065da4695">save</a> (const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
145
146<tr><td class="mdescLeft">&nbsp;</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 &amp;vector, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
148static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7c3b1846b2f29fb70e6a9d789daab808">save</a> (const vec &amp;vector, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</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 &amp;str, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
152static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7c822efd5f8550480d0756352d430c05">save</a> (const string &amp;<a class="el" href="classbdm_1_1str.html">str</a>, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</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 &amp;integer, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
156static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#8cd58216bcd732856846d18503c92d48">save</a> (const int &amp;integer, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
157
158<tr><td class="mdescLeft">&nbsp;</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 &amp;real, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
160static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#4e943ed7b3e65c9fd2842670fa8cf4a8">save</a> (const double &amp;real, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
161
162<tr><td class="mdescLeft">&nbsp;</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#d60234c0673f345424329894b9b0cef8">UI</a> (const string &amp;class_name, const type_info *const class_type_info)</td></tr>
165
166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor for internal use only, see.  <a href="#d60234c0673f345424329894b9b0cef8"></a><br></td></tr>
167</table>
168<hr><a name="_details"></a><h2>Detailed Description</h2>
169<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.
170<p>
171See 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&lt;T&gt;.<p>
172<a class="el" href="ui_page.html">User Infos and their use</a> <hr><h2>Constructor &amp; Destructor Documentation</h2>
173<a class="anchor" name="d60234c0673f345424329894b9b0cef8"></a><!-- doxytag: member="bdm::UI::UI" ref="d60234c0673f345424329894b9b0cef8" args="(const string &amp;class_name, const type_info *const class_type_info)" -->
174<div class="memitem">
175<div class="memproto">
176      <table class="memname">
177        <tr>
178          <td class="memname">bdm::UI::UI           </td>
179          <td>(</td>
180          <td class="paramtype">const string &amp;&nbsp;</td>
181          <td class="paramname"> <em>class_name</em>, </td>
182        </tr>
183        <tr>
184          <td class="paramkey"></td>
185          <td></td>
186          <td class="paramtype">const type_info *const &nbsp;</td>
187          <td class="paramname"> <em>class_type_info</em></td><td>&nbsp;</td>
188        </tr>
189        <tr>
190          <td></td>
191          <td>)</td>
192          <td></td><td></td><td><code> [inline, protected]</code></td>
193        </tr>
194      </table>
195</div>
196<div class="memdoc">
197
198<p>
199Constructor for internal use only, see.
200<p>
201<dl class="see" compact><dt><b>See also:</b></dt><dd>ParticularUI&lt;T&gt; </dd></dl>
202
203</div>
204</div><p>
205<hr><h2>Member Function Documentation</h2>
206<a class="anchor" name="f02851b299aedeb891e30c4807903081"></a><!-- doxytag: member="bdm::UI::build" ref="f02851b299aedeb891e30c4807903081" args="(const Setting &amp;element, const int index, SettingPresence settingPresence=optional)" -->
207<div class="memitem">
208<div class="memproto">
209<div class="memtemplate">
210template&lt;class T &gt; </div>
211      <table class="memname">
212        <tr>
213          <td class="memname">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt;T&gt; bdm::UI::build           </td>
214          <td>(</td>
215          <td class="paramtype">const Setting &amp;&nbsp;</td>
216          <td class="paramname"> <em>element</em>, </td>
217        </tr>
218        <tr>
219          <td class="paramkey"></td>
220          <td></td>
221          <td class="paramtype">const int&nbsp;</td>
222          <td class="paramname"> <em>index</em>, </td>
223        </tr>
224        <tr>
225          <td class="paramkey"></td>
226          <td></td>
227          <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a>&nbsp;</td>
228          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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>
240The new instance of type T* is constructed and initialized with values stored in the Setting element[index]<p>
241If 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&lt;T&gt;</a> is returned. When settingPresence is compulsory, the returned <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr&lt;T&gt;</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 &amp;element, const string &amp;name, SettingPresence settingPresence=optional)" -->
245<div class="memitem">
246<div class="memproto">
247<div class="memtemplate">
248template&lt;class T &gt; </div>
249      <table class="memname">
250        <tr>
251          <td class="memname">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt;T&gt; bdm::UI::build           </td>
252          <td>(</td>
253          <td class="paramtype">const Setting &amp;&nbsp;</td>
254          <td class="paramname"> <em>element</em>, </td>
255        </tr>
256        <tr>
257          <td class="paramkey"></td>
258          <td></td>
259          <td class="paramtype">const string &amp;&nbsp;</td>
260          <td class="paramname"> <em>name</em>, </td>
261        </tr>
262        <tr>
263          <td class="paramkey"></td>
264          <td></td>
265          <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a>&nbsp;</td>
266          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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>
278The new instance of type T* is constructed and initialized with values stored in the Setting element[name]<p>
279If 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&lt;T&gt;</a> is returned. When settingPresence is compulsory, the returned <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr&lt;T&gt;</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&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index, SettingPresence settingPresence=optional)" -->
283<div class="memitem">
284<div class="memproto">
285<div class="memtemplate">
286template&lt;class T &gt; </div>
287      <table class="memname">
288        <tr>
289          <td class="memname">static bool bdm::UI::get           </td>
290          <td>(</td>
291          <td class="paramtype">Array&lt; T &gt; &amp;&nbsp;</td>
292          <td class="paramname"> <em>array_to_load</em>, </td>
293        </tr>
294        <tr>
295          <td class="paramkey"></td>
296          <td></td>
297          <td class="paramtype">const Setting &amp;&nbsp;</td>
298          <td class="paramname"> <em>element</em>, </td>
299        </tr>
300        <tr>
301          <td class="paramkey"></td>
302          <td></td>
303          <td class="paramtype">const int&nbsp;</td>
304          <td class="paramname"> <em>index</em>, </td>
305        </tr>
306        <tr>
307          <td class="paramkey"></td>
308          <td></td>
309          <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a>&nbsp;</td>
310          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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>
322The 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&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name, SettingPresence settingPresence=optional)" -->
326<div class="memitem">
327<div class="memproto">
328<div class="memtemplate">
329template&lt;class T &gt; </div>
330      <table class="memname">
331        <tr>
332          <td class="memname">static bool bdm::UI::get           </td>
333          <td>(</td>
334          <td class="paramtype">Array&lt; T &gt; &amp;&nbsp;</td>
335          <td class="paramname"> <em>array_to_load</em>, </td>
336        </tr>
337        <tr>
338          <td class="paramkey"></td>
339          <td></td>
340          <td class="paramtype">const Setting &amp;&nbsp;</td>
341          <td class="paramname"> <em>element</em>, </td>
342        </tr>
343        <tr>
344          <td class="paramkey"></td>
345          <td></td>
346          <td class="paramtype">const string &amp;&nbsp;</td>
347          <td class="paramname"> <em>name</em>, </td>
348        </tr>
349        <tr>
350          <td class="paramkey"></td>
351          <td></td>
352          <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a>&nbsp;</td>
353          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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>
365The 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 &amp;instance, const Setting &amp;element, const int index, SettingPresence settingPresence=optional)" -->
369<div class="memitem">
370<div class="memproto">
371<div class="memtemplate">
372template&lt;class T &gt; </div>
373      <table class="memname">
374        <tr>
375          <td class="memname">static bool bdm::UI::get           </td>
376          <td>(</td>
377          <td class="paramtype">T &amp;&nbsp;</td>
378          <td class="paramname"> <em>instance</em>, </td>
379        </tr>
380        <tr>
381          <td class="paramkey"></td>
382          <td></td>
383          <td class="paramtype">const Setting &amp;&nbsp;</td>
384          <td class="paramname"> <em>element</em>, </td>
385        </tr>
386        <tr>
387          <td class="paramkey"></td>
388          <td></td>
389          <td class="paramtype">const int&nbsp;</td>
390          <td class="paramname"> <em>index</em>, </td>
391        </tr>
392        <tr>
393          <td class="paramkey"></td>
394          <td></td>
395          <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a>&nbsp;</td>
396          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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>
408The 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 &amp;instance, const Setting &amp;element, const string &amp;name, SettingPresence settingPresence=optional)" -->
412<div class="memitem">
413<div class="memproto">
414<div class="memtemplate">
415template&lt;class T &gt; </div>
416      <table class="memname">
417        <tr>
418          <td class="memname">static bool bdm::UI::get           </td>
419          <td>(</td>
420          <td class="paramtype">T &amp;&nbsp;</td>
421          <td class="paramname"> <em>instance</em>, </td>
422        </tr>
423        <tr>
424          <td class="paramkey"></td>
425          <td></td>
426          <td class="paramtype">const Setting &amp;&nbsp;</td>
427          <td class="paramname"> <em>element</em>, </td>
428        </tr>
429        <tr>
430          <td class="paramkey"></td>
431          <td></td>
432          <td class="paramtype">const string &amp;&nbsp;</td>
433          <td class="paramname"> <em>name</em>, </td>
434        </tr>
435        <tr>
436          <td class="paramkey"></td>
437          <td></td>
438          <td class="paramtype"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a>&nbsp;</td>
439          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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>
451The 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="merger_8h-source.html#l00262">bdm::merger_base::from_setting()</a>, <a class="el" href="kalman_8h-source.html#l00124">bdm::Kalman&lt; fsqmat &gt;::from_setting()</a>, <a class="el" href="kalman_8h-source.html#l00059">bdm::StateSpace&lt; sq_T &gt;::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#l01219">bdm::enorm&lt; sq_T &gt;::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00741">bdm::mgamma::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00641">bdm::mgnorm&lt; sq_T &gt;::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00581">bdm::mlnorm&lt; ldmat, enorm &gt;::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00522">bdm::euni::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00411">bdm::egamma::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00249">bdm::egiw::from_setting()</a>, <a class="el" href="exp__family_8cpp-source.html#l00334">bdm::mlognorm::from_setting()</a>, <a class="el" href="exp__family_8cpp-source.html#l00328">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_8cpp-source.html#l00058">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#l00992">bdm::BM::from_setting()</a>, <a class="el" href="bdmbase_8cpp-source.html#l00323">bdm::RV::from_setting()</a>, <a class="el" href="arx_8cpp-source.html#l00204">bdm::ARX::from_setting()</a>, and <a class="el" href="arx__ctrl_8h-source.html#l00055">bdm::LQG_ARX::from_settings()</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 Sat Aug 29 20:49:46 2009 for mixpp by&nbsp;
460<a href="http://www.doxygen.org/index.html">
461<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
462</body>
463</html>
Note: See TracBrowser for help on using the browser.