root/library/doc/html/classbdm_1_1Controller.html @ 651

Revision 651, 12.3 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

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::Controller 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.9 -->
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_1Controller.html">Controller</a>
67  </div>
68</div>
69<div class="contents">
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>
72
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>
79
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>
138</table>
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>
143</div>
144<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by&nbsp;
145<a href="http://www.doxygen.org/index.html">
146<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
147</body>
148</html>
Note: See TracBrowser for help on using the browser.