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

Revision 614, 22.8 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::mexDS 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_1mexDS.html">mexDS</a>
70  </div>
71</div>
72<div class="contents">
73<h1>bdm::mexDS Class Reference</h1><!-- doxytag: class="bdm::mexDS" --><!-- doxytag: inherits="bdm::DS" -->
74<p>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#a0b45e92047ef1676ad19a42902956c8b" title="Moves from  to , i.e. perfroms the actions and reads response of the system.">step()</a> to a matlab function. 
75<a href="#_details">More...</a></p>
76
77<p><code>#include &lt;<a class="el" href="mex__datasource_8h_source.html">mex_datasource.h</a>&gt;</code></p>
78
79<p><a href="classbdm_1_1mexDS-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="aca52c608ce9317abadc964b66ad12fa7"></a><!-- doxytag: member="bdm::mexDS::mexDS" ref="aca52c608ce9317abadc964b66ad12fa7" args="()" -->
83&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#aca52c608ce9317abadc964b66ad12fa7">mexDS</a> ()</td></tr>
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
85<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#a850902c28c607e11a624643b56592cf1">from_setting</a> (const Setting &amp;set)</td></tr>
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create memory data source from mxArray.  <a href="#a850902c28c607e11a624643b56592cf1"></a><br/></td></tr>
87<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b45e92047ef1676ad19a42902956c8b"></a><!-- doxytag: member="bdm::mexDS::step" ref="a0b45e92047ef1676ad19a42902956c8b" args="()" -->
88void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#a0b45e92047ef1676ad19a42902956c8b">step</a> ()</td></tr>
89<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>
90<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cae170c220af9ede0e3a335e404377e"></a><!-- doxytag: member="bdm::mexDS::write" ref="a2cae170c220af9ede0e3a335e404377e" args="(vec &amp;ut0)" -->
91void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#a2cae170c220af9ede0e3a335e404377e">write</a> (vec &amp;ut0)</td></tr>
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br/></td></tr>
93<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48e5a3ae6ce22a03e8325a10db1c04b4"></a><!-- doxytag: member="bdm::mexDS::getdata" ref="a48e5a3ae6ce22a03e8325a10db1c04b4" args="(vec &amp;dt_out)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#a48e5a3ae6ce22a03e8325a10db1c04b4">getdata</a> (vec &amp;dt_out)</td></tr>
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br/></td></tr>
96<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76d11928675f276f805655ae2a05d773"></a><!-- doxytag: member="bdm::mexDS::max_length" ref="a76d11928675f276f805655ae2a05d773" args="()" -->
97virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a76d11928675f276f805655ae2a05d773">max_length</a> ()</td></tr>
98<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#a339a488b93f2fc37c80d9a9573fbd421" title="Returns maximum number of provided data, by default it is set to maximum allowed...">MemDS.max_length()</a>. <br/></td></tr>
99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0bf451c7fea73ff4150ff9e83da4832"></a><!-- doxytag: member="bdm::mexDS::getdata" ref="aa0bf451c7fea73ff4150ff9e83da4832" args="(vec &amp;dt, const ivec &amp;indeces)" -->
100virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#aa0bf451c7fea73ff4150ff9e83da4832">getdata</a> (vec &amp;<a class="el" href="classbdm_1_1mexDS.html#abe43c4f080b96eed869071ab54dcd3d0">dt</a>, const ivec &amp;indeces)</td></tr>
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br/></td></tr>
102<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::mexDS::write" ref="a6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
103virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;<a class="el" href="classbdm_1_1mexDS.html#a3b4f1f85ecbe6f2d4ac3aa197b4bf1cf">ut</a>, const ivec &amp;indeces)</td></tr>
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br/></td></tr>
105<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c9e417d85052396fe74c164857ee67e"></a><!-- doxytag: member="bdm::mexDS::log_add" ref="a3c9e417d85052396fe74c164857ee67e" args="(logger &amp;L)" -->
106virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a3c9e417d85052396fe74c164857ee67e">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
107<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>
108<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae03d2c93cddd5c3a03107ddd3ae999cf"></a><!-- doxytag: member="bdm::mexDS::logit" ref="ae03d2c93cddd5c3a03107ddd3ae999cf" args="(logger &amp;L)" -->
109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ae03d2c93cddd5c3a03107ddd3ae999cf">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
110<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>
111<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::mexDS::_drv" ref="a069497b610296be053d862a2493be0ce" args="() const " -->
112virtual 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>
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
114<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::mexDS::_urv" ref="aa6a9a375da64c82fc227bda3418a1f33" args="() const " -->
115const <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>
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
117<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac09878f86907329ac631a3df8755c558"></a><!-- doxytag: member="bdm::mexDS::_yrv" ref="ac09878f86907329ac631a3df8755c558" args="() const " -->
118const <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>
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
120<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a92d77fd97fdb6bf1c8edb1e38c6bbc"></a><!-- doxytag: member="bdm::mexDS::set_drv" ref="a3a92d77fd97fdb6bf1c8edb1e38c6bbc" args="(const RV &amp;yrv, const RV &amp;urv)" -->
121virtual 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>
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random variables <br/></td></tr>
123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mexDS::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
124virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mexDS::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
127virtual 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>
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
129<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mexDS::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
130virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
132<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
133<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ef7f516ff47b8355a682d8c40dc908f"></a><!-- doxytag: member="bdm::mexDS::step_name" ref="a5ef7f516ff47b8355a682d8c40dc908f" args="" -->
134string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#a5ef7f516ff47b8355a682d8c40dc908f">step_name</a></td></tr>
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">identifier of matlab function <br/></td></tr>
136<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acfc4e8e5da04afde522bd23b07ab9230"></a><!-- doxytag: member="bdm::mexDS::input_name" ref="acfc4e8e5da04afde522bd23b07ab9230" args="" -->
137string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#acfc4e8e5da04afde522bd23b07ab9230">input_name</a></td></tr>
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">identifier of matlab input variabel <br/></td></tr>
139<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe43c4f080b96eed869071ab54dcd3d0"></a><!-- doxytag: member="bdm::mexDS::dt" ref="abe43c4f080b96eed869071ab54dcd3d0" args="" -->
140vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#abe43c4f080b96eed869071ab54dcd3d0">dt</a></td></tr>
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of results from name_step <br/></td></tr>
142<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b4f1f85ecbe6f2d4ac3aa197b4bf1cf"></a><!-- doxytag: member="bdm::mexDS::ut" ref="a3b4f1f85ecbe6f2d4ac3aa197b4bf1cf" args="" -->
143vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexDS.html#a3b4f1f85ecbe6f2d4ac3aa197b4bf1cf">ut</a></td></tr>
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of inputs <br/></td></tr>
145<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::mexDS::dtsize" ref="af96cae44624e79638a91ec4f2c7c81a9" args="" -->
146int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af96cae44624e79638a91ec4f2c7c81a9">dtsize</a></td></tr>
147<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>
148<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::mexDS::utsize" ref="ad7467046a0bd05bc992cc5e1bdedb983" args="" -->
149int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ad7467046a0bd05bc992cc5e1bdedb983">utsize</a></td></tr>
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data <br/></td></tr>
151<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a4b29aa6e9f3bf17bcc4b28567e8bd"></a><!-- doxytag: member="bdm::mexDS::ytsize" ref="a22a4b29aa6e9f3bf17bcc4b28567e8bd" args="" -->
152int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a22a4b29aa6e9f3bf17bcc4b28567e8bd">ytsize</a></td></tr>
153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of output <br/></td></tr>
154<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::mexDS::Drv" ref="ad8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
155<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>
156<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>
157<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::mexDS::Urv" ref="a9ac5970128fd39f4f6226723cd1de702" args="" -->
158<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>
159<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>
160<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb9de2a85f0d8257d79d9b68c05c4995"></a><!-- doxytag: member="bdm::mexDS::Yrv" ref="aeb9de2a85f0d8257d79d9b68c05c4995" args="" -->
161<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>
162<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of output data. <br/></td></tr>
163<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::mexDS::L_dt" ref="ab4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
164int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ab4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
165<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br/></td></tr>
166<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::mexDS::L_ut" ref="ab56b74ec21485846ccfad461f33b0e7a" args="" -->
167int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
168</table>
169<hr/><a name="_details"></a><h2>Detailed Description</h2>
170<p>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#a0b45e92047ef1676ad19a42902956c8b" title="Moves from  to , i.e. perfroms the actions and reads response of the system.">step()</a> to a matlab function. </p>
171<p>The identifier of matlab function is stored in attribute <code>name</code>. This identifier defines: </p>
172<ul>
173<li>function to call to do a <a class="el" href="classbdm_1_1mexDS.html#a0b45e92047ef1676ad19a42902956c8b" title="Moves from  to , i.e. perfroms the actions and reads response of the system.">step()</a>: name_step.m </li>
174<li>workspace variable to write input to: name_input </li>
175</ul>
176<hr/><h2>Member Function Documentation</h2>
177<a class="anchor" id="a850902c28c607e11a624643b56592cf1"></a><!-- doxytag: member="bdm::mexDS::from_setting" ref="a850902c28c607e11a624643b56592cf1" args="(const Setting &amp;set)" -->
178<div class="memitem">
179<div class="memproto">
180      <table class="memname">
181        <tr>
182          <td class="memname">void bdm::mexDS::from_setting </td>
183          <td>(</td>
184          <td class="paramtype">const Setting &amp;&nbsp;</td>
185          <td class="paramname"> <em>set</em></td>
186          <td>&nbsp;)&nbsp;</td>
187          <td><code> [inline, virtual]</code></td>
188        </tr>
189      </table>
190</div>
191<div class="memdoc">
192
193<p>Create memory data source from mxArray. </p>
194<div class="fragment"><pre class="fragment">        system={
195                type=<span class="stringliteral">&quot;mexDS&quot;</span>;
196                <a class="code" href="classbdm_1_1mexDS.html#a5ef7f516ff47b8355a682d8c40dc908f" title="identifier of matlab function">step_name</a>=<span class="stringliteral">&quot;&quot;</span>;              <span class="comment">// name of function to call</span>
197                <a class="code" href="classbdm_1_1mexDS.html#acfc4e8e5da04afde522bd23b07ab9230" title="identifier of matlab input variabel">input_name</a>=<span class="stringliteral">&quot;&quot;</span>;             <span class="comment">// name of workspace variable where inputs are written</span>
198                rv_out = {<span class="keyword">class</span>=<span class="stringliteral">&apos;RV&apos;</span>,...}  <span class="comment">// identification of outputs</span>
199                rv_in = {<span class="keyword">class</span>=<span class="stringliteral">&apos;RV&apos;</span>,...}   <span class="comment">// identification of inputs</span>
200                };
201</pre></div><p><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; </p>
202
203<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
204
205<p>References <a class="el" href="bdmbase_8h_source.html#l00951">bdm::DS::dtsize</a>, <a class="el" href="user__info_8h_source.html#l00443">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#l01023">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#l00953">bdm::DS::utsize</a>.</p>
206
207</div>
208</div>
209<hr/>The documentation for this class was generated from the following file:<ul>
210<li><a class="el" href="mex__datasource_8h_source.html">mex_datasource.h</a></li>
211</ul>
212</div>
213<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 22:40:44 2009 for mixpp by&nbsp;
214<a href="http://www.doxygen.org/index.html">
215<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
216</body>
217</html>
Note: See TracBrowser for help on using the browser.