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

Revision 661, 12.3 kB (checked in by smidl, 15 years ago)

doc

Line 
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"/>
5<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 -->
11<script type="text/javascript">
12<!--
13function changeDisplayState (e){
14  var num=this.id.replace(/[^[0-9]/g,'');
15  var button=this.firstChild;
16  var sectionDiv=document.getElementById('dynsection'+num);
17  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18    sectionDiv.style.display='block';
19    button.src='open.gif';
20  }else{
21    sectionDiv.style.display='none';
22    button.src='closed.gif';
23  }
24}
25function initDynSections(){
26  var divs=document.getElementsByTagName('div');
27  var sectionCounter=1;
28  for(var i=0;i<divs.length-1;i++){
29    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30      var header=divs[i];
31      var section=divs[i+1];
32      var button=header.firstChild;
33      if (button!='IMG'){
34        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35        button=document.createElement('img');
36        divs[i].insertBefore(button,divs[i].firstChild);
37      }
38      header.style.cursor='pointer';
39      header.onclick=changeDisplayState;
40      header.id='dynheader'+sectionCounter;
41      button.src='closed.gif';
42      section.id='dynsection'+sectionCounter;
43      section.style.display='none';
44      section.style.marginLeft='14px';
45      sectionCounter++;
46    }
47  }
48}
49window.onload = initDynSections;
50-->
51</script>
52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
58      <li><a href="files.html"><span>Files</span></a></li>
59    </ul>
60  </div>
61  <div class="tabs">
62    <ul>
63      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
65      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
66      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
67    </ul>
68  </div>
69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1Controller.html">Controller</a>
70  </div>
71</div>
72<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>
76
77<p><code>#include &lt;<a class="el" href="ctrlbase_8h_source.html">ctrlbase.h</a>&gt;</code></p>
78
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)" -->
83virtual 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)" -->
86virtual 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)" -->
89void&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="()" -->
92const <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="()" -->
95const <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="()" -->
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#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="a2a9541449b90cb80203a17af66cf64b7"></a><!-- doxytag: member="bdm::Controller::log_add" ref="a2a9541449b90cb80203a17af66cf64b7" args="(logger &amp;L, const string &amp;name=&quot;&quot;)" -->
101virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a2a9541449b90cb80203a17af66cf64b7">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L, const string &amp;name=&quot;&quot;)</td></tr>
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">register this controller with given datasource under name "name" <br/></td></tr>
103<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b05de6453a4ca665c662e998c53f31c"></a><!-- doxytag: member="bdm::Controller::logit" ref="a2b05de6453a4ca665c662e998c53f31c" args="(logger &amp;L)" -->
104virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a2b05de6453a4ca665c662e998c53f31c">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
105<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>
106<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::Controller::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
107virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
109<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 " -->
110virtual 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>
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
112<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::Controller::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
113virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
115<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
116<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ae938d29716585c5385df37ae861e18"></a><!-- doxytag: member="bdm::Controller::yrv" ref="a2ae938d29716585c5385df37ae861e18" args="" -->
117<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#a2ae938d29716585c5385df37ae861e18">yrv</a></td></tr>
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">identifier of the system output; <br/></td></tr>
119<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a357598cc95da1eed3d50751847e71f37"></a><!-- doxytag: member="bdm::Controller::urv" ref="a357598cc95da1eed3d50751847e71f37" args="" -->
120<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#a357598cc95da1eed3d50751847e71f37">urv</a></td></tr>
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">identifier of the system input; <br/></td></tr>
122<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10a2a88a4c275ead6aa2887a3b826b19"></a><!-- doxytag: member="bdm::Controller::drv" ref="a10a2a88a4c275ead6aa2887a3b826b19" 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#a10a2a88a4c275ead6aa2887a3b826b19">drv</a></td></tr>
124<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>
125<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8574445175a07f536fd3db007e1eac41"></a><!-- doxytag: member="bdm::Controller::LIDs" ref="a8574445175a07f536fd3db007e1eac41" args="" -->
126ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a8574445175a07f536fd3db007e1eac41">LIDs</a></td></tr>
127<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>
128</table>
129<hr/>The documentation for this class was generated from the following file:<ul>
130<li><a class="el" href="ctrlbase_8h_source.html">ctrlbase.h</a></li>
131</ul>
132</div>
133<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Oct 15 00:07:49 2009 for mixpp by&nbsp;
134<a href="http://www.doxygen.org/index.html">
135<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
136</body>
137</html>
Note: See TracBrowser for help on using the browser.