Show
Ignore:
Timestamp:
06/24/09 13:38:47 (16 years ago)
Author:
mido
Message:

UI documentation almost finished; UIException redesigned and used instead of UI::ui_error function

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1ArxDS.html

    r385 r396  
    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<!-- 
    … …  
    7272<a href="#_details">More...</a> 
    7373<p> 
    74 <code>#include &lt;<a class="el" href="libDS_8h-source.html">libDS.h</a>&gt;</code> 
     74<code>#include &lt;<a class="el" href="datasources_8h_source.html">datasources.h</a>&gt;</code> 
    7575<p> 
    7676 
    … …  
    123123 
    124124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> for logging into <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a> L. <br></td></tr> 
    125 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#6b8f76d576de14824df0257582cf7a33">from_setting</a> (const Setting &amp;root)</td></tr> 
     125<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#9b109ee7bba9774057b107383b6ecc24">from_setting</a> (const Setting &amp;set)</td></tr> 
    126126 
    127127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::ArxDS::_drv" ref="ed2113851294ed96abe60fc3f05aa660" args="() const " --> 
    … …  
    137137 
    138138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random rvariables <br></td></tr> 
    139 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::ArxDS::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    140 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
     139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::ArxDS::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     140virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    141141 
    142142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    143 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::ArxDS::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    144 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr> 
     143<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::ArxDS::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     144virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
    145145 
    146146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    147 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::ArxDS::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
    148 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
     147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::ArxDS::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     148virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    149149 
    150150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    … …  
    212212<hr><a name="_details"></a><h2>Detailed Description</h2> 
    213213Generator of <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data. <hr><h2>Member Function Documentation</h2> 
    214 <a class="anchor" name="6b8f76d576de14824df0257582cf7a33"></a><!-- doxytag: member="bdm::ArxDS::from_setting" ref="6b8f76d576de14824df0257582cf7a33" args="(const Setting &amp;root)" --> 
     214<a class="anchor" name="9b109ee7bba9774057b107383b6ecc24"></a><!-- doxytag: member="bdm::ArxDS::from_setting" ref="9b109ee7bba9774057b107383b6ecc24" args="(const Setting &amp;set)" --> 
    215215<div class="memitem"> 
    216216<div class="memproto"> 
    … …  
    220220          <td>(</td> 
    221221          <td class="paramtype">const Setting &amp;&nbsp;</td> 
    222           <td class="paramname"> <em>root</em>          </td> 
     222          <td class="paramname"> <em>set</em>          </td> 
    223223          <td>&nbsp;)&nbsp;</td> 
    224224          <td><code> [virtual]</code></td> 
    … …  
    229229 
    230230<p> 
    231 <a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a> for <a class="el" href="classbdm_1_1ArxDS.html" title="Generator of ARX data.">ArxDS</a> using factorized description!<p> 
     231<a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> for <a class="el" href="classbdm_1_1ArxDS.html" title="Generator of ARX data.">ArxDS</a> using factorized description!<p> 
    232232The <a class="el" href="classbdm_1_1ArxDS.html" title="Generator of ARX data.">ArxDS</a> is constructed from a structure with fields: <div class="fragment"><pre class="fragment">        system = { 
    233233                type = <span class="stringliteral">"ArxDS"</span>; 
    … …  
    255255</pre></div><p> 
    256256Result is <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data source offering with full history as Drv.  
    257 <p>Reimplemented from <a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">bdm::bdmroot</a>.</p> 
    258  
    259 <p>References <a class="el" href="libBM_8h-source.html#l00120">bdm::RV::_dsize()</a>, <a class="el" href="user__info_8h-source.html#l00248">bdm::UI::get()</a>, <a class="el" href="libDS_8h-source.html#l00168">set_drv()</a>, <a class="el" href="libDS_8h-source.html#l00188">set_options()</a>, and <a class="el" href="libDS_8h-source.html#l00165">set_parameters()</a>.</p> 
     257<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p> 
     258 
     259<p>References <a class="el" href="user__info_8h_source.html#l00358">bdm::UI::get()</a>, <a class="el" href="datasources_8h_source.html#l00168">set_drv()</a>, <a class="el" href="datasources_8h_source.html#l00188">set_options()</a>, and <a class="el" href="datasources_8h_source.html#l00165">set_parameters()</a>.</p> 
    260260 
    261261</div> 
    262262</div><p> 
    263263<hr>The documentation for this class was generated from the following files:<ul> 
    264 <li><a class="el" href="libDS_8h-source.html">libDS.h</a><li>libDS.cpp</ul> 
    265 </div> 
    266 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     264<li><a class="el" href="datasources_8h_source.html">datasources.h</a><li>datasources.cpp</ul> 
     265</div> 
     266<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:48 2009 for mixpp by&nbsp; 
    267267<a href="http://www.doxygen.org/index.html"> 
    268 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     268<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    269269</body> 
    270270</html>