Show
Ignore:
Timestamp:
08/05/09 00:16:53 (15 years ago)
Author:
mido
Message:

obnovena dokumentace, vcetne pridani mnoha novych doc-souboru do svn

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • library/doc/html/classbdm_1_1UI.html

    r401 r472  
    55<link href="doxygen.css" rel="stylesheet" type="text/css"> 
    66</head><body> 
    7 <!-- Generated by Doxygen 1.5.8 --> 
     7<!-- Generated by Doxygen 1.5.9 --> 
    88<script type="text/javascript"> 
    99<!-- 
     
    5252      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 
    5353      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li> 
    54       <li><a href="modules.html"><span>Modules</span></a></li> 
    5554      <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 
    5655      <li><a href="files.html"><span>Files</span></a></li> 
     
    6968</div> 
    7069<div class="contents"> 
    71 <h1>bdm::UI Class Reference</h1><!-- doxytag: class="bdm::UI" --><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> is an abstract class and it is intended for internal purposes only 
     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 
    7271<a href="#_details">More...</a> 
    7372<p> 
    74 <code>#include &lt;<a class="el" href="user__info_8h-source.html">user_info.h</a>&gt;</code> 
     73<code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code> 
    7574<p> 
    7675 
     
    8180<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>MappedUI</b></td></tr> 
    8281 
     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">Enumerical type used to determine whether the data for concrete Settingis is compulsory or optional. <br></td></tr> 
    8388<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> 
    8489<tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr> 
    85 <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.">root</a> descendant class <br><br></div></td></tr> 
    86 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="dda27449f8bd19d54db9ccfb2644e908"></a><!-- doxytag: member="bdm::UI::build" ref="dda27449f8bd19d54db9ccfb2644e908" args="(const Setting &amp;element, const string &amp;name)" --> 
    87 template&lt;class T &gt; </td></tr> 
    88 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#dda27449f8bd19d54db9ccfb2644e908">build</a> (const Setting &amp;element, const string &amp;name)</td></tr> 
    89  
    90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The new instance of type T* is constructed and initialized with values stored in the Setting element[name]. <br></td></tr> 
    91 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="f0eccc7bbe4b680f3e1cb84b455a1125"></a><!-- doxytag: member="bdm::UI::build" ref="f0eccc7bbe4b680f3e1cb84b455a1125" args="(const Setting &amp;element, const int index)" --> 
    92 template&lt;class T &gt; </td></tr> 
    93 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#f0eccc7bbe4b680f3e1cb84b455a1125">build</a> (const Setting &amp;element, const int index)</td></tr> 
    94  
    95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The new instance of type T* is constructed and initialized with values stored in the Setting element[index]. <br></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 T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#970297d6c758692135877dfa7a5eacb0">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 T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#b8b2512d4762463cbf23314d45f1c5b1">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 
    9697<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="6e2da6a142fecf5f21e0bb86a7211cb4"></a><!-- doxytag: member="bdm::UI::build" ref="6e2da6a142fecf5f21e0bb86a7211cb4" args="(const Setting &amp;element)" --> 
    9798template&lt;class T &gt; </td></tr> 
     
    101102<tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr> 
    102103<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> 
    103 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="652bfd23f5052e4f1cb317057d74a3e2"></a><!-- doxytag: member="bdm::UI::get" ref="652bfd23f5052e4f1cb317057d74a3e2" args="(T &amp;instance, const Setting &amp;element, const string &amp;name)" --> 
     104<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     105<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> 
     106 
     107<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     108<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> 
     109 
     110<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)" --> 
    104111template&lt;class T &gt; </td></tr> 
    105 <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#652bfd23f5052e4f1cb317057d74a3e2">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;name)</td></tr> 
    106  
    107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element[name]. <br></td></tr> 
    108 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="3d04bb3d7dbcf0da0b4d5d3d5b7df51a"></a><!-- doxytag: member="bdm::UI::get" ref="3d04bb3d7dbcf0da0b4d5d3d5b7df51a" args="(T &amp;instance, const Setting &amp;element, const int index)" --> 
    109 template&lt;class T &gt; </td></tr> 
    110 <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#3d04bb3d7dbcf0da0b4d5d3d5b7df51a">get</a> (T &amp;instance, const Setting &amp;element, const int index)</td></tr> 
    111  
    112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element[index]. <br></td></tr> 
    113 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="25747ac6d0232aa7102dbb316f65ddce"></a><!-- doxytag: member="bdm::UI::get" ref="25747ac6d0232aa7102dbb316f65ddce" args="(T &amp;instance, const Setting &amp;element)" --> 
    114 template&lt;class T &gt; </td></tr> 
    115 <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#25747ac6d0232aa7102dbb316f65ddce">get</a> (T &amp;instance, const Setting &amp;element)</td></tr> 
     112<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> 
    116113 
    117114<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> 
    118115<tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array&lt;T&gt;</div></td></tr> 
    119116<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> 
    120 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="00bb5f2a328d272b0a3ffbda1a902d54"></a><!-- doxytag: member="bdm::UI::get" ref="00bb5f2a328d272b0a3ffbda1a902d54" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)" --> 
     117<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     118<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> 
     119 
     120<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     121<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> 
     122 
     123<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)" --> 
    121124template&lt;class T &gt; </td></tr> 
    122 <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#00bb5f2a328d272b0a3ffbda1a902d54">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)</td></tr> 
    123  
    124 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element[name]. <br></td></tr> 
    125 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="b6a224b6aea027e167d3d565b39144e0"></a><!-- doxytag: member="bdm::UI::get" ref="b6a224b6aea027e167d3d565b39144e0" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)" --> 
    126 template&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#b6a224b6aea027e167d3d565b39144e0">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)</td></tr> 
    128  
    129 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element[index]. <br></td></tr> 
    130 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4fc5efdc58e4e184218b6d5beeb5ceab"></a><!-- doxytag: member="bdm::UI::get" ref="4fc5efdc58e4e184218b6d5beeb5ceab" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)" --> 
    131 template&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"><a class="el" href="classbdm_1_1UI.html#4fc5efdc58e4e184218b6d5beeb5ceab">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)</td></tr> 
     125<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> 
    133126 
    134127<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> 
     
    175168</table> 
    176169<hr><a name="_details"></a><h2>Detailed Description</h2> 
    177 <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> is an abstract class and it is intended for internal purposes only.  
    178 <p> 
    179 This class exists mainly to allow pointers to its templated descendant ParticularUI&lt;T&gt;. Next, it collects all the auxiliary functions useful to prepare some concret user-infos, see static methods 'build', 'get' and 'save'. <hr><h2>Constructor &amp; Destructor Documentation</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> 
     172See 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> 
     173<a class="el" href="ui_page.html">User Infos and their use</a> <hr><h2>Constructor &amp; Destructor Documentation</h2> 
    180174<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)" --> 
    181175<div class="memitem"> 
     
    210204</div> 
    211205</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 &amp;element, const int index, SettingPresence settingPresence=optional)" --> 
     208<div class="memitem"> 
     209<div class="memproto"> 
     210<div class="memtemplate"> 
     211template&lt;class T &gt; </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 &amp;&nbsp;</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&nbsp;</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>&nbsp;</td> 
     229          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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> 
     241The new instance of type T* is constructed and initialized with values stored in the Setting element[index]<p> 
     242If 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 &amp;element, const string &amp;name, SettingPresence settingPresence=optional)" --> 
     246<div class="memitem"> 
     247<div class="memproto"> 
     248<div class="memtemplate"> 
     249template&lt;class T &gt; </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 &amp;&nbsp;</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 &amp;&nbsp;</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>&nbsp;</td> 
     267          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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> 
     279The new instance of type T* is constructed and initialized with values stored in the Setting element[name]<p> 
     280If 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&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index, SettingPresence settingPresence=optional)" --> 
     284<div class="memitem"> 
     285<div class="memproto"> 
     286<div class="memtemplate"> 
     287template&lt;class T &gt; </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&lt; T &gt; &amp;&nbsp;</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 &amp;&nbsp;</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&nbsp;</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>&nbsp;</td> 
     311          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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> 
     323The 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&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name, SettingPresence settingPresence=optional)" --> 
     327<div class="memitem"> 
     328<div class="memproto"> 
     329<div class="memtemplate"> 
     330template&lt;class T &gt; </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&lt; T &gt; &amp;&nbsp;</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 &amp;&nbsp;</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 &amp;&nbsp;</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>&nbsp;</td> 
     354          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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> 
     366The 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 &amp;instance, const Setting &amp;element, const int index, SettingPresence settingPresence=optional)" --> 
     370<div class="memitem"> 
     371<div class="memproto"> 
     372<div class="memtemplate"> 
     373template&lt;class T &gt; </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 &amp;&nbsp;</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 &amp;&nbsp;</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&nbsp;</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>&nbsp;</td> 
     397          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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> 
     409The 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 &amp;instance, const Setting &amp;element, const string &amp;name, SettingPresence settingPresence=optional)" --> 
     413<div class="memitem"> 
     414<div class="memproto"> 
     415<div class="memtemplate"> 
     416template&lt;class T &gt; </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 &amp;&nbsp;</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 &amp;&nbsp;</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 &amp;&nbsp;</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>&nbsp;</td> 
     440          <td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td>&nbsp;</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> 
     452The 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&lt; sq_T &gt;::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&lt; sq_T &gt;::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00565">bdm::mlnorm&lt; ldmat &gt;::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> 
    212457<hr>The documentation for this class was generated from the following files:<ul> 
    213 <li><a class="el" href="user__info_8h-source.html">user_info.h</a><li>user_info.cpp</ul> 
    214 </div> 
    215 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 1 13:05:57 2009 for mixpp by&nbsp; 
     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&nbsp; 
    216461<a href="http://www.doxygen.org/index.html"> 
    217 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     462<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    218463</body> 
    219464</html>