Show
Ignore:
Timestamp:
10/12/09 13:49:39 (15 years ago)
Author:
mido
Message:

\doc directory cleaned a bit

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1Controller.html

    r641 r651  
    1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    2 <html xmlns="http://www.w3.org/1999/xhtml"> 
    3 <head> 
    4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 
     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"> 
    53<title>mixpp: bdm::Controller Class Reference</title> 
    6 <link href="tabs.css" rel="stylesheet" type="text/css"/> 
    7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> 
    8 </head> 
    9 <body> 
    10 <!-- Generated by Doxygen 1.6.1 --> 
     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 --> 
    118<script type="text/javascript"> 
    129<!-- 
    … …  
    7168</div> 
    7269<div class="contents"> 
    73 <h1>bdm::Controller Class Reference</h1><!-- doxytag: class="bdm::Controller" --><!-- doxytag: inherits="bdm::root" --><hr/><a name="_details"></a><h2>Detailed Description</h2> 
    74 <p>Base class for adaptive controllers The base class is however non-adaptive, method <code><a class="el" href="classbdm_1_1Controller.html#ad8bf38082502020d56dbd48806018774" title="function processing new observations and adapting control strategy accordingly">adapt()</a></code> is empty. </p> 
    75 <dl class="note"><dt><b>Note:</b></dt><dd>advanced Controllers will probably include estimator as their internal attribute (e.g. dual controllers) </dd></dl> 
     70<h1>bdm::Controller Class Reference</h1><!-- doxytag: class="bdm::Controller" --><!-- doxytag: inherits="bdm::root" --><code>#include &lt;<a class="el" href="ctrlbase_8h_source.html">ctrlbase.h</a>&gt;</code> 
     71<p> 
    7672 
    77 <p><code>#include &lt;<a class="el" href="ctrlbase_8h_source.html">ctrlbase.h</a>&gt;</code></p> 
     73<p> 
     74<a href="classbdm_1_1Controller-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
     75<tr><td></td></tr> 
     76<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
     77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8bf38082502020d56dbd48806018774"></a><!-- doxytag: member="bdm::Controller::adapt" ref="d8bf38082502020d56dbd48806018774" args="(const vec &amp;data)" --> 
     78virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#d8bf38082502020d56dbd48806018774">adapt</a> (const vec &amp;data)</td></tr> 
    7879 
    79 <p><a href="classbdm_1_1Controller-members.html">List of all members.</a></p> 
    80 <table border="0" cellpadding="0" cellspacing="0"> 
    81 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
    82 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8bf38082502020d56dbd48806018774"></a><!-- doxytag: member="bdm::Controller::adapt" ref="ad8bf38082502020d56dbd48806018774" args="(const vec &amp;data)" --> 
    83 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#ad8bf38082502020d56dbd48806018774">adapt</a> (const vec &amp;data)</td></tr> 
    84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function processing new observations and adapting control strategy accordingly <br/></td></tr> 
    85 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7103224088fcd72bc44eeb08ad5ce180"></a><!-- doxytag: member="bdm::Controller::ctrlaction" ref="a7103224088fcd72bc44eeb08ad5ce180" args="(const vec &amp;data)" --> 
    86 virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a7103224088fcd72bc44eeb08ad5ce180">ctrlaction</a> (const vec &amp;data)</td></tr> 
    87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns designed control action <br/></td></tr> 
    88 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8dfccd2b84552efcdc7f595c021ff77"></a><!-- doxytag: member="bdm::Controller::from_setting" ref="aa8dfccd2b84552efcdc7f595c021ff77" args="(const Setting &amp;set)" --> 
    89 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#aa8dfccd2b84552efcdc7f595c021ff77">from_setting</a> (const Setting &amp;set)</td></tr> 
    90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br/></td></tr> 
    91 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c5b40a9e65abc1434c8a34c9752e25d"></a><!-- doxytag: member="bdm::Controller::_urv" ref="a5c5b40a9e65abc1434c8a34c9752e25d" args="()" --> 
    92 const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a5c5b40a9e65abc1434c8a34c9752e25d">_urv</a> ()</td></tr> 
    93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr> 
    94 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a258f7c6435343b088ed02a304cab99b0"></a><!-- doxytag: member="bdm::Controller::_yrv" ref="a258f7c6435343b088ed02a304cab99b0" args="()" --> 
    95 const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a258f7c6435343b088ed02a304cab99b0">_yrv</a> ()</td></tr> 
    96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr> 
    97 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51e1fbd42ba80789f31b5bc14068f498"></a><!-- doxytag: member="bdm::Controller::_drv" ref="a51e1fbd42ba80789f31b5bc14068f498" args="()" --> 
    98 const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a51e1fbd42ba80789f31b5bc14068f498">_drv</a> ()</td></tr> 
    99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr> 
    100 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::Controller::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" --> 
    101 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr> 
    103 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::Controller::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
    104 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
    105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr> 
    106 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::Controller::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
    107 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr> 
     80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function processing new observations and adapting control strategy accordingly <br></td></tr> 
     81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7103224088fcd72bc44eeb08ad5ce180"></a><!-- doxytag: member="bdm::Controller::ctrlaction" ref="7103224088fcd72bc44eeb08ad5ce180" args="(const vec &amp;data)" --> 
     82virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#7103224088fcd72bc44eeb08ad5ce180">ctrlaction</a> (const vec &amp;data)</td></tr> 
     83 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns designed control action <br></td></tr> 
     85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8dfccd2b84552efcdc7f595c021ff77"></a><!-- doxytag: member="bdm::Controller::from_setting" ref="a8dfccd2b84552efcdc7f595c021ff77" args="(const Setting &amp;set)" --> 
     86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a8dfccd2b84552efcdc7f595c021ff77">from_setting</a> (const Setting &amp;set)</td></tr> 
     87 
     88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr> 
     89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5c5b40a9e65abc1434c8a34c9752e25d"></a><!-- doxytag: member="bdm::Controller::_urv" ref="5c5b40a9e65abc1434c8a34c9752e25d" args="()" --> 
     90const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#5c5b40a9e65abc1434c8a34c9752e25d">_urv</a> ()</td></tr> 
     91 
     92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="258f7c6435343b088ed02a304cab99b0"></a><!-- doxytag: member="bdm::Controller::_yrv" ref="258f7c6435343b088ed02a304cab99b0" args="()" --> 
     94const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#258f7c6435343b088ed02a304cab99b0">_yrv</a> ()</td></tr> 
     95 
     96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51e1fbd42ba80789f31b5bc14068f498"></a><!-- doxytag: member="bdm::Controller::_drv" ref="51e1fbd42ba80789f31b5bc14068f498" args="()" --> 
     98const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#51e1fbd42ba80789f31b5bc14068f498">_drv</a> ()</td></tr> 
     99 
     100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a9541449b90cb80203a17af66cf64b7"></a><!-- doxytag: member="bdm::Controller::log_add" ref="2a9541449b90cb80203a17af66cf64b7" args="(logger &amp;L, const string &amp;name=&quot;&quot;)" --> 
     102virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#2a9541449b90cb80203a17af66cf64b7">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L, const string &amp;name=&quot;&quot;)</td></tr> 
     103 
     104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">register this controller with given datasource under name "name" <br></td></tr> 
     105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b05de6453a4ca665c662e998c53f31c"></a><!-- doxytag: member="bdm::Controller::logit" ref="2b05de6453a4ca665c662e998c53f31c" args="(logger &amp;L)" --> 
     106virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#2b05de6453a4ca665c662e998c53f31c">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr> 
     107 
     108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">write requested values into the <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a> <br></td></tr> 
     109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::Controller::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     110virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
     111 
     112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
     113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::Controller::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     114virtual 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> 
     115 
     116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
     117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::Controller::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     118virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
     119 
     120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
     121<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
     122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ae938d29716585c5385df37ae861e18"></a><!-- doxytag: member="bdm::Controller::yrv" ref="2ae938d29716585c5385df37ae861e18" args="" --> 
     123<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#2ae938d29716585c5385df37ae861e18">yrv</a></td></tr> 
     124 
     125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">identifier of the system output; <br></td></tr> 
     126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="357598cc95da1eed3d50751847e71f37"></a><!-- doxytag: member="bdm::Controller::urv" ref="357598cc95da1eed3d50751847e71f37" args="" --> 
     127<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#357598cc95da1eed3d50751847e71f37">urv</a></td></tr> 
     128 
     129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">identifier of the system input; <br></td></tr> 
     130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10a2a88a4c275ead6aa2887a3b826b19"></a><!-- doxytag: member="bdm::Controller::drv" ref="10a2a88a4c275ead6aa2887a3b826b19" args="" --> 
     131<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#10a2a88a4c275ead6aa2887a3b826b19">drv</a></td></tr> 
     132 
     133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">description of data needed for <code>ctrlaction</code> , required for automatic connection to <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> <br></td></tr> 
     134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8574445175a07f536fd3db007e1eac41"></a><!-- doxytag: member="bdm::Controller::LIDs" ref="8574445175a07f536fd3db007e1eac41" args="" --> 
     135ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#8574445175a07f536fd3db007e1eac41">LIDs</a></td></tr> 
     136 
     137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a> IDs <br></td></tr> 
    109138</table> 
    110 <hr/>The documentation for this class was generated from the following file:<ul> 
    111 <li><a class="el" href="ctrlbase_8h_source.html">ctrlbase.h</a></li> 
    112 </ul> 
     139<hr><a name="_details"></a><h2>Detailed Description</h2> 
     140Base class for adaptive controllers The base class is however non-adaptive, method <code><a class="el" href="classbdm_1_1Controller.html#d8bf38082502020d56dbd48806018774" title="function processing new observations and adapting control strategy accordingly">adapt()</a></code> is empty. <dl class="note" compact><dt><b>Note:</b></dt><dd>advanced Controllers will probably include estimator as their internal attribute (e.g. dual controllers) </dd></dl> 
     141<hr>The documentation for this class was generated from the following file:<ul> 
     142<li><a class="el" href="ctrlbase_8h_source.html">ctrlbase.h</a></ul> 
    113143</div> 
    114 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 27 00:49:05 2009 for mixpp by&nbsp; 
     144<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by&nbsp; 
    115145<a href="http://www.doxygen.org/index.html"> 
    116 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> 
     146<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    117147</body> 
    118148</html>