root/library/doc/html/classbdm_1_1FileDS.html @ 608

Revision 608, 18.8 kB (checked in by smidl, 15 years ago)

doc

RevLine 
[591]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"/>
[287]5<title>mixpp: bdm::FileDS Class Reference</title>
[591]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 -->
[271]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>
[259]52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
[271]55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
[259]56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
[290]57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
[259]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>
[290]64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
[259]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>
[287]69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1FileDS.html">FileDS</a>
[259]70  </div>
71</div>
72<div class="contents">
[591]73<h1>bdm::FileDS Class Reference</h1><!-- doxytag: class="bdm::FileDS" --><!-- doxytag: inherits="bdm::MemDS" -->
74<p><code>#include &lt;<a class="el" href="datasources_8h_source.html">datasources.h</a>&gt;</code></p>
[259]75
[591]76<p><a href="classbdm_1_1FileDS-members.html">List of all members.</a></p>
77<table border="0" cellpadding="0" cellspacing="0">
78<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
79<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bf36650e9d1af2d0743ffe8a3fcff14"></a><!-- doxytag: member="bdm::FileDS::getdata" ref="a0bf36650e9d1af2d0743ffe8a3fcff14" args="(vec &amp;dt)" -->
80void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a0bf36650e9d1af2d0743ffe8a3fcff14">getdata</a> (vec &amp;dt)</td></tr>
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br/></td></tr>
82<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c546e8d9eb71e079e046e3d2f69c6c4"></a><!-- doxytag: member="bdm::FileDS::getdata" ref="a3c546e8d9eb71e079e046e3d2f69c6c4" args="(vec &amp;dt, const ivec &amp;indices)" -->
83void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a3c546e8d9eb71e079e046e3d2f69c6c4">getdata</a> (vec &amp;dt, const ivec &amp;indices)</td></tr>
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br/></td></tr>
85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6af63065097147b390e684a7842a26a"></a><!-- doxytag: member="bdm::FileDS::ndat" ref="aa6af63065097147b390e684a7842a26a" args="()" -->
86int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#aa6af63065097147b390e684a7842a26a">ndat</a> ()</td></tr>
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns number of data in the file; <br/></td></tr>
88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a998f590eeddee97ae6918671e40756b8"></a><!-- doxytag: member="bdm::FileDS::log_add" ref="a998f590eeddee97ae6918671e40756b8" args="(logger &amp;L)" -->
89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a998f590eeddee97ae6918671e40756b8">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br/></td></tr>
91<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59d44ef34a523127dd79c076461c43b6"></a><!-- doxytag: member="bdm::FileDS::logit" ref="a59d44ef34a523127dd79c076461c43b6" args="(logger &amp;L)" -->
92void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a59d44ef34a523127dd79c076461c43b6">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br/></td></tr>
94<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6428f2778254e8304fb5a799b7f815a"></a><!-- doxytag: member="bdm::FileDS::set_rvs" ref="ae6428f2778254e8304fb5a799b7f815a" args="(RV &amp;drv, RV &amp;urv)" -->
[271]95void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rvs</b> (<a class="el" href="classbdm_1_1RV.html">RV</a> &amp;drv, <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
[591]96<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a7f17598fe2b458707ba932865beef5"></a><!-- doxytag: member="bdm::FileDS::write" ref="a9a7f17598fe2b458707ba932865beef5" args="(vec &amp;ut)" -->
97void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a9a7f17598fe2b458707ba932865beef5">write</a> (vec &amp;ut)</td></tr>
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br/></td></tr>
99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4349a043d00fd82c8d5f5c39673787e5"></a><!-- doxytag: member="bdm::FileDS::write" ref="a4349a043d00fd82c8d5f5c39673787e5" args="(vec &amp;ut, ivec &amp;indices)" -->
[271]100void&nbsp;</td><td class="memItemRight" valign="bottom"><b>write</b> (vec &amp;ut, ivec &amp;indices)</td></tr>
[591]101<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::FileDS::write" ref="a6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
102virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;ut, const ivec &amp;indeces)</td></tr>
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br/></td></tr>
104<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::FileDS::step" ref="a21916feb3e5ff960855c09b06a0d279b" args="()" -->
105void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr>
[608]106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_18.png"/> to <img class="formulaInl" alt="$ t+1 $" src="form_19.png"/>, i.e. perfroms the actions and reads response of the system. <br/></td></tr>
107<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::FileDS::_drv" ref="a069497b610296be053d862a2493be0ce" args="() const " -->
108virtual 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_1DS.html#a069497b610296be053d862a2493be0ce">_drv</a> () const </td></tr>
[591]109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::FileDS::_urv" ref="aa6a9a375da64c82fc227bda3418a1f33" args="() const " -->
111const <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#aa6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr>
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
[608]113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac09878f86907329ac631a3df8755c558"></a><!-- doxytag: member="bdm::FileDS::_yrv" ref="ac09878f86907329ac631a3df8755c558" args="() const " -->
114const <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#ac09878f86907329ac631a3df8755c558">_yrv</a> () const </td></tr>
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
116<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a92d77fd97fdb6bf1c8edb1e38c6bbc"></a><!-- doxytag: member="bdm::FileDS::set_drv" ref="a3a92d77fd97fdb6bf1c8edb1e38c6bbc" args="(const RV &amp;yrv, const RV &amp;urv)" -->
117virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a3a92d77fd97fdb6bf1c8edb1e38c6bbc">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;yrv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random variables <br/></td></tr>
[591]119<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::FileDS::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
120virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
122<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::FileDS::from_setting" ref="a0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" -->
123virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</td></tr>
124<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>
125<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::FileDS::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
126virtual 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>
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
128<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::FileDS::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
129virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
131<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
132<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa724f4cbfc32e79bacc044253234e260"></a><!-- doxytag: member="bdm::FileDS::Data" ref="aa724f4cbfc32e79bacc044253234e260" args="" -->
133mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#aa724f4cbfc32e79bacc044253234e260">Data</a></td></tr>
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal matrix of data <br/></td></tr>
135<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a681ee3831f68f4f20ed54e04e8b3f107"></a><!-- doxytag: member="bdm::FileDS::time" ref="a681ee3831f68f4f20ed54e04e8b3f107" args="" -->
136int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a681ee3831f68f4f20ed54e04e8b3f107">time</a></td></tr>
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">active column in the Data matrix <br/></td></tr>
138<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a865814d49913dcf672bb20a4334d3dc4"></a><!-- doxytag: member="bdm::FileDS::rowid" ref="a865814d49913dcf672bb20a4334d3dc4" args="" -->
139ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a865814d49913dcf672bb20a4334d3dc4">rowid</a></td></tr>
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of rows that are presented in Dt <br/></td></tr>
141<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a166522aed4d3b12d9b3c2afaf6673301"></a><!-- doxytag: member="bdm::FileDS::delays" ref="a166522aed4d3b12d9b3c2afaf6673301" args="" -->
142ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a166522aed4d3b12d9b3c2afaf6673301">delays</a></td></tr>
143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of delays that are presented in Dt <br/></td></tr>
144<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::FileDS::dtsize" ref="af96cae44624e79638a91ec4f2c7c81a9" args="" -->
[608]145int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af96cae44624e79638a91ec4f2c7c81a9">dtsize</a></td></tr>
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data returned by <code><a class="el" href="classbdm_1_1DS.html#ac1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code> <br/></td></tr>
[591]147<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::FileDS::utsize" ref="ad7467046a0bd05bc992cc5e1bdedb983" args="" -->
[608]148int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ad7467046a0bd05bc992cc5e1bdedb983">utsize</a></td></tr>
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data <br/></td></tr>
150<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a4b29aa6e9f3bf17bcc4b28567e8bd"></a><!-- doxytag: member="bdm::FileDS::ytsize" ref="a22a4b29aa6e9f3bf17bcc4b28567e8bd" args="" -->
151int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a22a4b29aa6e9f3bf17bcc4b28567e8bd">ytsize</a></td></tr>
152<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of output <br/></td></tr>
[591]153<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::FileDS::Drv" ref="ad8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
154<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#ad8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data returned by <code><a class="el" href="classbdm_1_1DS.html#ac1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code>. <br/></td></tr>
156<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::FileDS::Urv" ref="a9ac5970128fd39f4f6226723cd1de702" args="" -->
157<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#a9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data witten by by <code><a class="el" href="classbdm_1_1DS.html#af5baeee8528e5e4c5c7a344b2e3f192a" title="Accepts action variable and schedule it for application.">write()</a></code>. <br/></td></tr>
[608]159<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb9de2a85f0d8257d79d9b68c05c4995"></a><!-- doxytag: member="bdm::FileDS::Yrv" ref="aeb9de2a85f0d8257d79d9b68c05c4995" args="" -->
160<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#aeb9de2a85f0d8257d79d9b68c05c4995">Yrv</a></td></tr>
161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of output data. <br/></td></tr>
[591]162<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::FileDS::L_dt" ref="ab4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
163int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ab4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br/></td></tr>
165<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::FileDS::L_ut" ref="ab56b74ec21485846ccfad461f33b0e7a" args="" -->
[264]166int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
[259]167</table>
[591]168<hr/><a name="_details"></a><h2>Detailed Description</h2>
169<p>Pseudovirtual class for reading data from files </p>
170<hr/>The documentation for this class was generated from the following file:<ul>
171<li><a class="el" href="datasources_8h_source.html">datasources.h</a></li>
172</ul>
[397]173</div>
[608]174<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by&nbsp;
[259]175<a href="http://www.doxygen.org/index.html">
[591]176<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
[259]177</body>
178</html>
Note: See TracBrowser for help on using the browser.