root/doc/html/classbdm_1_1DS.html @ 270

Revision 270, 11.7 kB (checked in by smidl, 15 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

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::DS Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1DS.html">DS</a>
28  </div>
29</div>
30<div class="contents">
31<h1>bdm::DS Class Reference</h1><!-- doxytag: class="bdm::DS" --><!-- doxytag: inherits="bdm::bdmroot" --><code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
32<p>
33<div class="dynheader">
34Inheritance diagram for bdm::DS:</div>
35<div class="dynsection">
36<p><center><img src="classbdm_1_1DS__inherit__graph.png" border="0" usemap="#bdm_1_1DS__inherit__map" alt="Inheritance graph"></center>
37<map name="bdm_1_1DS__inherit__map">
38<area shape="rect" href="classbdm_1_1ArxDS.html" title="Generator of ARX data." alt="" coords="7,161,105,188"><area shape="rect" href="classbdm_1_1MemDS.html" title="Memory storage of off&#45;line data column&#45;wise." alt="" coords="129,161,239,188"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="128,7,240,33"></map>
39<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
40
41<p>
42<a href="classbdm_1_1DS-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
43Abstract class for discrete-time sources of data.
44<p>
45The class abstracts operations of: (i) data aquisition, (ii) data-preprocessing, (iii) scaling of data, and (iv) data resampling from the task of estimation and control. Moreover, for controlled systems, it is able to receive the desired control action and perform it in the next step. (Or as soon as possible). <table border="0" cellpadding="0" cellspacing="0">
46<tr><td></td></tr>
47<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bedd82e08ae6686b4b1732a122c2201a"></a><!-- doxytag: member="bdm::DS::DS" ref="bedd82e08ae6686b4b1732a122c2201a" args="()" -->
49&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#bedd82e08ae6686b4b1732a122c2201a">DS</a> ()</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructors <br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1ec862dec7164fee3284c6f9a51b0ba"></a><!-- doxytag: member="bdm::DS::getdata" ref="c1ec862dec7164fee3284c6f9a51b0ba" args="(vec &amp;dt)" -->
53virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#c1ec862dec7164fee3284c6f9a51b0ba">getdata</a> (vec &amp;dt)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0bf451c7fea73ff4150ff9e83da4832"></a><!-- doxytag: member="bdm::DS::getdata" ref="a0bf451c7fea73ff4150ff9e83da4832" args="(vec &amp;dt, const ivec &amp;indeces)" -->
57virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a0bf451c7fea73ff4150ff9e83da4832">getdata</a> (vec &amp;dt, const ivec &amp;indeces)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5baeee8528e5e4c5c7a344b2e3f192a"></a><!-- doxytag: member="bdm::DS::write" ref="f5baeee8528e5e4c5c7a344b2e3f192a" args="(vec &amp;ut)" -->
61virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#f5baeee8528e5e4c5c7a344b2e3f192a">write</a> (vec &amp;ut)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::DS::write" ref="6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
65virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;ut, const ivec &amp;indeces)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a14c64d881e838ddc3a5617ee8a973b"></a><!-- doxytag: member="bdm::DS::step" ref="9a14c64d881e838ddc3a5617ee8a973b" args="()=0" -->
69virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#9a14c64d881e838ddc3a5617ee8a973b">step</a> ()=0</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_110.png"> to <img class="formulaInl" alt="$ t+1 $" src="form_111.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c9e417d85052396fe74c164857ee67e"></a><!-- doxytag: member="bdm::DS::log_add" ref="3c9e417d85052396fe74c164857ee67e" args="(logger &amp;L)" -->
73virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#3c9e417d85052396fe74c164857ee67e">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
74
75<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>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e03d2c93cddd5c3a03107ddd3ae999cf"></a><!-- doxytag: member="bdm::DS::logit" ref="e03d2c93cddd5c3a03107ddd3ae999cf" args="(logger &amp;L)" -->
77virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#e03d2c93cddd5c3a03107ddd3ae999cf">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
78
79<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>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::DS::_drv" ref="ed2113851294ed96abe60fc3f05aa660" args="() const " -->
81virtual <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ed2113851294ed96abe60fc3f05aa660">_drv</a> () const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::DS::_urv" ref="a6a9a375da64c82fc227bda3418a1f33" args="() const " -->
85const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
88<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::DS::dtsize" ref="f96cae44624e79638a91ec4f2c7c81a9" args="" -->
90int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr>
91
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::DS::utsize" ref="d7467046a0bd05bc992cc5e1bdedb983" args="" -->
93int&nbsp;</td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr>
94
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::DS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
96<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#d8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data returned by <code><a class="el" href="classbdm_1_1DS.html#c1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code>. <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::DS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
100<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data witten by by <code><a class="el" href="classbdm_1_1DS.html#f5baeee8528e5e4c5c7a344b2e3f192a" title="Accepts action variable and schedule it for application.">write()</a></code>. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::DS::L_dt" ref="b4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
104int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#b4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::DS::L_ut" ref="b56b74ec21485846ccfad461f33b0e7a" args="" -->
108int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
109
110</table>
111<hr>The documentation for this class was generated from the following file:<ul>
112<li><a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
113</div>
114<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:05 2009 for mixpp by&nbsp;
115<a href="http://www.doxygen.org/index.html">
116<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
117</body>
118</html>
Note: See TracBrowser for help on using the browser.