Show
Ignore:
Timestamp:
08/16/09 18:14:04 (15 years ago)
Author:
smidl
Message:

Documentation regenerated

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1UI.html

    r472 r538  
    55<link href="doxygen.css" rel="stylesheet" type="text/css"> 
    66</head><body> 
    7 <!-- Generated by Doxygen 1.5.9 --> 
     7<!-- Generated by Doxygen 1.5.8 --> 
    88<script type="text/javascript"> 
    99<!-- 
    … …  
    7171<a href="#_details">More...</a> 
    7272<p> 
    73 <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> 
    7474<p> 
    7575 
    … …  
    8585 }</td></tr> 
    8686 
    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> 
     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> 
    8888<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> 
    8989<tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr> 
    9090<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> 
    9191<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  
    97 <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)" --> 
    98 template&lt;class T &gt; </td></tr> 
    99 <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#6e2da6a142fecf5f21e0bb86a7211cb4">build</a> (const Setting &amp;element)</td></tr> 
    100  
    101 <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. <br></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 
    10297<tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr> 
    10398<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> 
    … …  
    133128 
    134129<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 
    135134<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;)" --> 
    136135template&lt;class T &gt; </td></tr> 
    … …  
    165164<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> 
    166165 
    167 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor for internal use only, see.  <a href="#d60234c0673f345424329894b9b0cef8"></a><br></td></tr> 
     166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor for internal use only, see.  <a href="#d60234c0673f345424329894b9b0cef8"></a><br></td></tr> 
    168167</table> 
    169168<hr><a name="_details"></a><h2>Detailed Description</h2> 
    … …  
    198197 
    199198<p> 
    200 Default constructor for internal use only, see.  
     199Constructor for internal use only, see.  
    201200<p> 
    202201<dl class="see" compact><dt><b>See also:</b></dt><dd>ParticularUI&lt;T&gt; </dd></dl> 
    … …  
    205204</div><p> 
    206205<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"> 
    211 template&lt;class T &gt; </div> 
    212       <table class="memname"> 
    213         <tr> 
    214           <td class="memname">static T* bdm::UI::build           </td> 
     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> 
    215214          <td>(</td> 
    216215          <td class="paramtype">const Setting &amp;&nbsp;</td> 
    … …  
    240239<p> 
    241240The 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 &amp;element, const string &amp;name, SettingPresence settingPresence=optional)" --> 
    246 <div class="memitem"> 
    247 <div class="memproto"> 
    248 <div class="memtemplate"> 
    249 template&lt;class T &gt; </div> 
    250       <table class="memname"> 
    251         <tr> 
    252           <td class="memname">static T* bdm::UI::build           </td> 
     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> 
    253252          <td>(</td> 
    254253          <td class="paramtype">const Setting &amp;&nbsp;</td> 
    … …  
    278277<p> 
    279278The 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.  
     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).  
    281280</div> 
    282281</div><p> 
    … …  
    451450<p> 
    452451The 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> 
     452<p>Referenced by <a class="el" href="merger_8h-source.html#l00289">bdm::merger_base::from_setting()</a>, <a class="el" href="kalman_8cpp-source.html#l00292">bdm::MultiModel::from_setting()</a>, <a class="el" href="kalman_8cpp-source.html#l00256">bdm::EKFCh::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l01184">bdm::enorm&lt; sq_T &gt;::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00723">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#l00563">bdm::mlnorm&lt; ldmat, enorm &gt;::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00504">bdm::euni::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00392">bdm::egamma::from_setting()</a>, <a class="el" href="exp__family_8h-source.html#l00234">bdm::egiw::from_setting()</a>, <a class="el" href="exp__family_8cpp-source.html#l00336">bdm::mlognorm::from_setting()</a>, <a class="el" href="exp__family_8cpp-source.html#l00330">bdm::migamma_ref::from_setting()</a>, <a class="el" href="emix_8h-source.html#l00357">bdm::mprod::from_setting()</a>, <a class="el" href="datasources_8cpp-source.html#l00058">bdm::ArxDS::from_setting()</a>, <a class="el" href="bdmbase_8cpp-source.html#l00286">bdm::RV::from_setting()</a>, and <a class="el" href="arx_8cpp-source.html#l00195">bdm::ARX::from_setting()</a>.</p> 
    454453 
    455454</div> 
    456455</div><p> 
    457456<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&nbsp; 
     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 Sun Aug 16 17:58:19 2009 for mixpp by&nbsp; 
    461460<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> 
     461<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
    463462</body> 
    464463</html>