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

Revision 651, 22.8 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::mexDS 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_1mexDS.html">mexDS</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::mexDS Class Reference</h1><!-- doxytag: class="bdm::mexDS" --><!-- doxytag: inherits="bdm::DS" -->Matlab wrapper for <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> mapping functions <a class="el" href="classbdm_1_1mexDS.html#0b45e92047ef1676ad19a42902956c8b" title="Moves from  to , i.e. perfroms the actions and reads response of the system.">step()</a> to a matlab function. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="mex__datasource_8h_source.html">mex_datasource.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1mexDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca52c608ce9317abadc964b66ad12fa7"></a><!-- doxytag: member="bdm::mexDS::mexDS" ref="ca52c608ce9317abadc964b66ad12fa7" args="()" -->
81&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#ca52c608ce9317abadc964b66ad12fa7">mexDS</a> ()</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#850902c28c607e11a624643b56592cf1">from_setting</a> (const Setting &amp;set)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create memory data source from mxArray.  <a href="#850902c28c607e11a624643b56592cf1"></a><br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b45e92047ef1676ad19a42902956c8b"></a><!-- doxytag: member="bdm::mexDS::step" ref="0b45e92047ef1676ad19a42902956c8b" args="()" -->
88void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#0b45e92047ef1676ad19a42902956c8b">step</a> ()</td></tr>
89
90<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>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2cae170c220af9ede0e3a335e404377e"></a><!-- doxytag: member="bdm::mexDS::write" ref="2cae170c220af9ede0e3a335e404377e" args="(vec &amp;ut0)" -->
92void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#2cae170c220af9ede0e3a335e404377e">write</a> (vec &amp;ut0)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="48e5a3ae6ce22a03e8325a10db1c04b4"></a><!-- doxytag: member="bdm::mexDS::getdata" ref="48e5a3ae6ce22a03e8325a10db1c04b4" args="(vec &amp;dt_out)" -->
96void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#48e5a3ae6ce22a03e8325a10db1c04b4">getdata</a> (vec &amp;dt_out)</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76d11928675f276f805655ae2a05d773"></a><!-- doxytag: member="bdm::mexDS::max_length" ref="76d11928675f276f805655ae2a05d773" args="()" -->
100virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#76d11928675f276f805655ae2a05d773">max_length</a> ()</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns maximum number of provided data, by default it is set to maximum allowed length, shorter <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> should overload this method! See, <a class="el" href="classbdm_1_1MemDS.html#339a488b93f2fc37c80d9a9573fbd421" title="Returns maximum number of provided data, by default it is set to maximum allowed...">MemDS.max_length()</a>. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0bf451c7fea73ff4150ff9e83da4832"></a><!-- doxytag: member="bdm::mexDS::getdata" ref="a0bf451c7fea73ff4150ff9e83da4832" args="(vec &amp;dt, const ivec &amp;indeces)" -->
104virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a0bf451c7fea73ff4150ff9e83da4832">getdata</a> (vec &amp;<a class="el" href="classbdm_1_1mexDS.html#be43c4f080b96eed869071ab54dcd3d0">dt</a>, const ivec &amp;indeces)</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::mexDS::write" ref="6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
108virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;<a class="el" href="classbdm_1_1mexDS.html#3b4f1f85ecbe6f2d4ac3aa197b4bf1cf">ut</a>, const ivec &amp;indeces)</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c9e417d85052396fe74c164857ee67e"></a><!-- doxytag: member="bdm::mexDS::log_add" ref="3c9e417d85052396fe74c164857ee67e" args="(logger &amp;L)" -->
112virtual 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>
113
114<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>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e03d2c93cddd5c3a03107ddd3ae999cf"></a><!-- doxytag: member="bdm::mexDS::logit" ref="e03d2c93cddd5c3a03107ddd3ae999cf" args="(logger &amp;L)" -->
116virtual 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>
117
118<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>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::mexDS::_drv" ref="069497b610296be053d862a2493be0ce" args="() const " -->
120virtual 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#069497b610296be053d862a2493be0ce">_drv</a> () const </td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::mexDS::_urv" ref="a6a9a375da64c82fc227bda3418a1f33" args="() const " -->
124const <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>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c09878f86907329ac631a3df8755c558"></a><!-- doxytag: member="bdm::mexDS::_yrv" ref="c09878f86907329ac631a3df8755c558" args="() const " -->
128const <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#c09878f86907329ac631a3df8755c558">_yrv</a> () const </td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a92d77fd97fdb6bf1c8edb1e38c6bbc"></a><!-- doxytag: member="bdm::mexDS::set_drv" ref="3a92d77fd97fdb6bf1c8edb1e38c6bbc" args="(const RV &amp;yrv, const RV &amp;urv)" -->
132virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#3a92d77fd97fdb6bf1c8edb1e38c6bbc">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>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random variables <br></td></tr>
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mexDS::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
136virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mexDS::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
140virtual 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>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
143<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mexDS::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
144virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
145
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
147<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ef7f516ff47b8355a682d8c40dc908f"></a><!-- doxytag: member="bdm::mexDS::step_name" ref="5ef7f516ff47b8355a682d8c40dc908f" args="" -->
149string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#5ef7f516ff47b8355a682d8c40dc908f">step_name</a></td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">identifier of matlab function <br></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfc4e8e5da04afde522bd23b07ab9230"></a><!-- doxytag: member="bdm::mexDS::input_name" ref="cfc4e8e5da04afde522bd23b07ab9230" args="" -->
153string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#cfc4e8e5da04afde522bd23b07ab9230">input_name</a></td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">identifier of matlab input variabel <br></td></tr>
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be43c4f080b96eed869071ab54dcd3d0"></a><!-- doxytag: member="bdm::mexDS::dt" ref="be43c4f080b96eed869071ab54dcd3d0" args="" -->
157vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#be43c4f080b96eed869071ab54dcd3d0">dt</a></td></tr>
158
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of results from name_step <br></td></tr>
160<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b4f1f85ecbe6f2d4ac3aa197b4bf1cf"></a><!-- doxytag: member="bdm::mexDS::ut" ref="3b4f1f85ecbe6f2d4ac3aa197b4bf1cf" args="" -->
161vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#3b4f1f85ecbe6f2d4ac3aa197b4bf1cf">ut</a></td></tr>
162
163<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of inputs <br></td></tr>
164<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::mexDS::dtsize" ref="f96cae44624e79638a91ec4f2c7c81a9" args="" -->
165int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#f96cae44624e79638a91ec4f2c7c81a9">dtsize</a></td></tr>
166
167<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size 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>
168<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::mexDS::utsize" ref="d7467046a0bd05bc992cc5e1bdedb983" args="" -->
169int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#d7467046a0bd05bc992cc5e1bdedb983">utsize</a></td></tr>
170
171<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data <br></td></tr>
172<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22a4b29aa6e9f3bf17bcc4b28567e8bd"></a><!-- doxytag: member="bdm::mexDS::ytsize" ref="22a4b29aa6e9f3bf17bcc4b28567e8bd" args="" -->
173int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#22a4b29aa6e9f3bf17bcc4b28567e8bd">ytsize</a></td></tr>
174
175<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of output <br></td></tr>
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::mexDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
177<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>
178
179<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>
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::mexDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
181<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>
182
183<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>
184<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb9de2a85f0d8257d79d9b68c05c4995"></a><!-- doxytag: member="bdm::mexDS::Yrv" ref="eb9de2a85f0d8257d79d9b68c05c4995" args="" -->
185<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#eb9de2a85f0d8257d79d9b68c05c4995">Yrv</a></td></tr>
186
187<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of output data. <br></td></tr>
188<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::mexDS::L_dt" ref="b4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
189int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#b4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
190
191<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br></td></tr>
192<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::mexDS::L_ut" ref="b56b74ec21485846ccfad461f33b0e7a" args="" -->
193int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
194
195</table>
196<hr><a name="_details"></a><h2>Detailed Description</h2>
197Matlab wrapper for <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> mapping functions <a class="el" href="classbdm_1_1mexDS.html#0b45e92047ef1676ad19a42902956c8b" title="Moves from  to , i.e. perfroms the actions and reads response of the system.">step()</a> to a matlab function.
198<p>
199The identifier of matlab function is stored in attribute <code>name</code>. This identifier defines: <ul>
200<li>function to call to do a <a class="el" href="classbdm_1_1mexDS.html#0b45e92047ef1676ad19a42902956c8b" title="Moves from  to , i.e. perfroms the actions and reads response of the system.">step()</a>: name_step.m </li>
201<li>workspace variable to write input to: name_input </li>
202</ul>
203<hr><h2>Member Function Documentation</h2>
204<a class="anchor" name="850902c28c607e11a624643b56592cf1"></a><!-- doxytag: member="bdm::mexDS::from_setting" ref="850902c28c607e11a624643b56592cf1" args="(const Setting &amp;set)" -->
205<div class="memitem">
206<div class="memproto">
207      <table class="memname">
208        <tr>
209          <td class="memname">void bdm::mexDS::from_setting           </td>
210          <td>(</td>
211          <td class="paramtype">const Setting &amp;&nbsp;</td>
212          <td class="paramname"> <em>set</em>          </td>
213          <td>&nbsp;)&nbsp;</td>
214          <td><code> [inline, virtual]</code></td>
215        </tr>
216      </table>
217</div>
218<div class="memdoc">
219
220<p>
221Create memory data source from mxArray.
222<p>
223<div class="fragment"><pre class="fragment">        system={
224                type=<span class="stringliteral">"mexDS"</span>;
225                <a class="code" href="classbdm_1_1mexDS.html#5ef7f516ff47b8355a682d8c40dc908f" title="identifier of matlab function">step_name</a>=<span class="stringliteral">""</span>;              <span class="comment">// name of function to call</span>
226                <a class="code" href="classbdm_1_1mexDS.html#cfc4e8e5da04afde522bd23b07ab9230" title="identifier of matlab input variabel">input_name</a>=<span class="stringliteral">""</span>;             <span class="comment">// name of workspace variable where inputs are written</span>
227                rv_out = {<span class="keyword">class</span>=<span class="stringliteral">'RV'</span>,...}  <span class="comment">// identification of outputs</span>
228                rv_in = {<span class="keyword">class</span>=<span class="stringliteral">'RV'</span>,...}   <span class="comment">// identification of inputs</span>
229                };
230</pre></div><p>
231<a class="el" href="classbdm_1_1MemDS.html" title="Memory storage of off-line data column-wise.">MemDS</a> with the above fields will be created;
232<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
233
234<p>References <a class="el" href="bdmbase_8h_source.html#l00953">bdm::DS::dtsize</a>, <a class="el" href="user__info_8h_source.html#l00451">bdm::UI::get()</a>, <a class="el" href="mex__datasource_8h_source.html#l00079">input_name</a>, <a class="el" href="bdmbase_8h_source.html#l01028">bdm::DS::set_drv()</a>, <a class="el" href="mex__datasource_8h_source.html#l00077">step_name</a>, and <a class="el" href="bdmbase_8h_source.html#l00955">bdm::DS::utsize</a>.</p>
235
236</div>
237</div><p>
238<hr>The documentation for this class was generated from the following file:<ul>
239<li><a class="el" href="mex__datasource_8h_source.html">mex_datasource.h</a></ul>
240</div>
241<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:47 2009 for mixpp by&nbsp;
242<a href="http://www.doxygen.org/index.html">
243<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
244</body>
245</html>
Note: See TracBrowser for help on using the browser.