root/library/doc/html/classbdm_1_1ITppFileDS.html @ 591

Revision 591, 17.7 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::ITppFileDS 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_1ITppFileDS.html">ITppFileDS</a>
70  </div>
71</div>
72<div class="contents">
73<h1>bdm::ITppFileDS Class Reference</h1><!-- doxytag: class="bdm::ITppFileDS" --><!-- doxytag: inherits="bdm::FileDS" -->
74<p>Read Data Matrix from an IT file. 
75<a href="#_details">More...</a></p>
76
77<p><code>#include &lt;<a class="el" href="datasources_8h_source.html">datasources.h</a>&gt;</code></p>
78
79<p><a href="classbdm_1_1ITppFileDS-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="a9a1ea166e35aaaa1660905ed7249608c"></a><!-- doxytag: member="bdm::ITppFileDS::ITppFileDS" ref="a9a1ea166e35aaaa1660905ed7249608c" args="(const string &amp;fname, const string &amp;varname)" -->
83&nbsp;</td><td class="memItemRight" valign="bottom"><b>ITppFileDS</b> (const string &amp;fname, const string &amp;varname)</td></tr>
84<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd192da176625a909fa853458b604566"></a><!-- doxytag: member="bdm::ITppFileDS::from_setting" ref="afd192da176625a909fa853458b604566" args="(const Setting &amp;set)" -->
85void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ITppFileDS.html#afd192da176625a909fa853458b604566">from_setting</a> (const Setting &amp;set)</td></tr>
86<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>
87<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bf36650e9d1af2d0743ffe8a3fcff14"></a><!-- doxytag: member="bdm::ITppFileDS::getdata" ref="a0bf36650e9d1af2d0743ffe8a3fcff14" args="(vec &amp;dt)" -->
88void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a0bf36650e9d1af2d0743ffe8a3fcff14">getdata</a> (vec &amp;dt)</td></tr>
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br/></td></tr>
90<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c546e8d9eb71e079e046e3d2f69c6c4"></a><!-- doxytag: member="bdm::ITppFileDS::getdata" ref="a3c546e8d9eb71e079e046e3d2f69c6c4" args="(vec &amp;dt, const ivec &amp;indices)" -->
91void&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>
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br/></td></tr>
93<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6af63065097147b390e684a7842a26a"></a><!-- doxytag: member="bdm::ITppFileDS::ndat" ref="aa6af63065097147b390e684a7842a26a" args="()" -->
94int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#aa6af63065097147b390e684a7842a26a">ndat</a> ()</td></tr>
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns number of data in the file; <br/></td></tr>
96<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a998f590eeddee97ae6918671e40756b8"></a><!-- doxytag: member="bdm::ITppFileDS::log_add" ref="a998f590eeddee97ae6918671e40756b8" args="(logger &amp;L)" -->
97void&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>
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br/></td></tr>
99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59d44ef34a523127dd79c076461c43b6"></a><!-- doxytag: member="bdm::ITppFileDS::logit" ref="a59d44ef34a523127dd79c076461c43b6" args="(logger &amp;L)" -->
100void&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>
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br/></td></tr>
102<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6428f2778254e8304fb5a799b7f815a"></a><!-- doxytag: member="bdm::ITppFileDS::set_rvs" ref="ae6428f2778254e8304fb5a799b7f815a" args="(RV &amp;drv, RV &amp;urv)" -->
103void&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>
104<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a7f17598fe2b458707ba932865beef5"></a><!-- doxytag: member="bdm::ITppFileDS::write" ref="a9a7f17598fe2b458707ba932865beef5" args="(vec &amp;ut)" -->
105void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a9a7f17598fe2b458707ba932865beef5">write</a> (vec &amp;ut)</td></tr>
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br/></td></tr>
107<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4349a043d00fd82c8d5f5c39673787e5"></a><!-- doxytag: member="bdm::ITppFileDS::write" ref="a4349a043d00fd82c8d5f5c39673787e5" args="(vec &amp;ut, ivec &amp;indices)" -->
108void&nbsp;</td><td class="memItemRight" valign="bottom"><b>write</b> (vec &amp;ut, ivec &amp;indices)</td></tr>
109<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::ITppFileDS::write" ref="a6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
110virtual 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>
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br/></td></tr>
112<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::ITppFileDS::step" ref="a21916feb3e5ff960855c09b06a0d279b" args="()" -->
113void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr>
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_12.png"/> to <img class="formulaInl" alt="$ t+1 $" src="form_13.png"/>, i.e. perfroms the actions and reads response of the system. <br/></td></tr>
115<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::ITppFileDS::_drv" ref="aed2113851294ed96abe60fc3f05aa660" args="() const " -->
116virtual <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#aed2113851294ed96abe60fc3f05aa660">_drv</a> () const </td></tr>
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
118<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::ITppFileDS::_urv" ref="aa6a9a375da64c82fc227bda3418a1f33" args="() const " -->
119const <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>
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
121<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a821297dfd839d68691324f024e57252f"></a><!-- doxytag: member="bdm::ITppFileDS::set_drv" ref="a821297dfd839d68691324f024e57252f" args="(const RV &amp;drv, const RV &amp;urv)" -->
122virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a821297dfd839d68691324f024e57252f">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;drv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random rvariables <br/></td></tr>
124<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::ITppFileDS::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
125virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
127<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::ITppFileDS::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
128virtual 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>
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
130<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::ITppFileDS::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
131virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
133<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
134<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa724f4cbfc32e79bacc044253234e260"></a><!-- doxytag: member="bdm::ITppFileDS::Data" ref="aa724f4cbfc32e79bacc044253234e260" args="" -->
135mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#aa724f4cbfc32e79bacc044253234e260">Data</a></td></tr>
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal matrix of data <br/></td></tr>
137<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a681ee3831f68f4f20ed54e04e8b3f107"></a><!-- doxytag: member="bdm::ITppFileDS::time" ref="a681ee3831f68f4f20ed54e04e8b3f107" args="" -->
138int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a681ee3831f68f4f20ed54e04e8b3f107">time</a></td></tr>
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">active column in the Data matrix <br/></td></tr>
140<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a865814d49913dcf672bb20a4334d3dc4"></a><!-- doxytag: member="bdm::ITppFileDS::rowid" ref="a865814d49913dcf672bb20a4334d3dc4" args="" -->
141ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a865814d49913dcf672bb20a4334d3dc4">rowid</a></td></tr>
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of rows that are presented in Dt <br/></td></tr>
143<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a166522aed4d3b12d9b3c2afaf6673301"></a><!-- doxytag: member="bdm::ITppFileDS::delays" ref="a166522aed4d3b12d9b3c2afaf6673301" args="" -->
144ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a166522aed4d3b12d9b3c2afaf6673301">delays</a></td></tr>
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of delays that are presented in Dt <br/></td></tr>
146<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::ITppFileDS::dtsize" ref="af96cae44624e79638a91ec4f2c7c81a9" args="" -->
147int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr>
148<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::ITppFileDS::utsize" ref="ad7467046a0bd05bc992cc5e1bdedb983" args="" -->
149int&nbsp;</td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr>
150<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::ITppFileDS::Drv" ref="ad8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
151<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>
152<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>
153<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::ITppFileDS::Urv" ref="a9ac5970128fd39f4f6226723cd1de702" 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#a9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
155<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>
156<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::ITppFileDS::L_dt" ref="ab4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
157int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ab4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br/></td></tr>
159<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::ITppFileDS::L_ut" ref="ab56b74ec21485846ccfad461f33b0e7a" args="" -->
160int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
161</table>
162<hr/><a name="_details"></a><h2>Detailed Description</h2>
163<p>Read Data Matrix from an IT file. </p>
164<p>The constructor creates an internal matrix <code>Data</code> from an IT++ file. The file is binary and can be made using the IT++ library or the Matlab/Octave function itsave. NB: the data are stored columnwise, i.e. each column contains the data for time <img class="formulaInl" alt="$t$" src="form_15.png"/>! </p>
165<hr/>The documentation for this class was generated from the following files:<ul>
166<li><a class="el" href="datasources_8h_source.html">datasources.h</a></li>
167<li>datasources.cpp</li>
168</ul>
169</div>
170<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:50 2009 for mixpp by&nbsp;
171<a href="http://www.doxygen.org/index.html">
172<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
173</body>
174</html>
Note: See TracBrowser for help on using the browser.