root/doc/html/classpmsmDS.html @ 324

Revision 323, 17.3 kB (checked in by smidl, 16 years ago)

doc

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: pmsmDS 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.8 -->
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><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67</div>
68<div class="contents">
69<h1>pmsmDS Class Reference</h1><!-- doxytag: class="pmsmDS" --><!-- doxytag: inherits="bdm::DS" -->Simulator of PMSM machine with predefined profile on omega. 
70<a href="#_details">More...</a>
71<p>
72<code>#include &lt;<a class="el" href="pmsmDS_8h-source.html">pmsmDS.h</a>&gt;</code>
73<p>
74
75<p>
76<a href="classpmsmDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
77<tr><td></td></tr>
78<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#e6a50a246de039f30cb5423521aab55c">pmsmDS</a> ()</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">options for logging, -  <a href="#e6a50a246de039f30cb5423521aab55c"></a><br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73073ee4f905af3f9f96a6130e9a9e22"></a><!-- doxytag: member="pmsmDS::set_parameters" ref="73073ee4f905af3f9f96a6130e9a9e22" args="(double Rs0, double Ls0, double Fmag0, double Bf0, double p0, double kp0, double J0, double Uc0, double DT0, double dt0)" -->
83void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (double Rs0, double Ls0, double Fmag0, double Bf0, double p0, double kp0, double J0, double Uc0, double DT0, double dt0)</td></tr>
84
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="75dd22db70746bfd0c3e685a17bbf34a"></a><!-- doxytag: member="pmsmDS::set_options" ref="75dd22db70746bfd0c3e685a17bbf34a" args="(string &amp;opt)" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#75dd22db70746bfd0c3e685a17bbf34a">set_options</a> (string &amp;opt)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">parse options: "modelu" =&gt; opt_modu=true; <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e47e678eb56e0b3bd47d801d0995e46"></a><!-- doxytag: member="pmsmDS::getdata" ref="4e47e678eb56e0b3bd47d801d0995e46" args="(vec &amp;dt)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#4e47e678eb56e0b3bd47d801d0995e46">getdata</a> (vec &amp;dt)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e9a2b9d82bd1b71d66778021d1e8b4"></a><!-- doxytag: member="pmsmDS::write" ref="35e9a2b9d82bd1b71d66778021d1e8b4" args="(vec &amp;ut)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#35e9a2b9d82bd1b71d66778021d1e8b4">write</a> (vec &amp;ut)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="664fc8deff7c141ee7ab826a9abb387b"></a><!-- doxytag: member="pmsmDS::step" ref="664fc8deff7c141ee7ab826a9abb387b" args="()" -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#664fc8deff7c141ee7ab826a9abb387b">step</a> ()</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_51.png"> to <img class="formulaInl" alt="$ t+1 $" src="form_52.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d75b83468db25c56977ffccff46b0b37"></a><!-- doxytag: member="pmsmDS::log_add" ref="d75b83468db25c56977ffccff46b0b37" args="(logger &amp;L)" -->
102void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#d75b83468db25c56977ffccff46b0b37">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register DS for logging into logger L. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21cac6deaac2dd073c982d7bec839b47"></a><!-- doxytag: member="pmsmDS::logit" ref="21cac6deaac2dd073c982d7bec839b47" args="(logger &amp;L)" -->
106void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#21cac6deaac2dd073c982d7bec839b47">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register DS for logging into logger L. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bcea4f040063f65ae39a4ca21f6aff1f"></a><!-- doxytag: member="pmsmDS::set_profile" ref="bcea4f040063f65ae39a4ca21f6aff1f" args="(double dt, const vec &amp;Ww, const vec &amp;Mz)" -->
110void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_profile</b> (double dt, const vec &amp;Ww, const vec &amp;Mz)</td></tr>
111
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0bf451c7fea73ff4150ff9e83da4832"></a><!-- doxytag: member="pmsmDS::getdata" ref="a0bf451c7fea73ff4150ff9e83da4832" args="(vec &amp;dt, const ivec &amp;indeces)" -->
113virtual 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>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="pmsmDS::write" ref="6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
117virtual 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>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="pmsmDS::_drv" ref="ed2113851294ed96abe60fc3f05aa660" args="() const " -->
121virtual RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ed2113851294ed96abe60fc3f05aa660">_drv</a> () const </td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="pmsmDS::_urv" ref="a6a9a375da64c82fc227bda3418a1f33" args="() const " -->
125const RV &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
128<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3975e648cc981a550997df8120e176f7"></a><!-- doxytag: member="pmsmDS::L_x" ref="3975e648cc981a550997df8120e176f7" args="" -->
130int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#3975e648cc981a550997df8120e176f7">L_x</a></td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indeces of logged variables <br></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a45b0843888a7c7675a264953814d9c2"></a><!-- doxytag: member="pmsmDS::L_ou" ref="a45b0843888a7c7675a264953814d9c2" args="" -->
134int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ou</b></td></tr>
135
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4fe8c4c1994547875973492bf3c909dd"></a><!-- doxytag: member="pmsmDS::L_oy" ref="4fe8c4c1994547875973492bf3c909dd" args="" -->
137int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_oy</b></td></tr>
138
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ec5b692e1be1623a08196ac2da7b56b"></a><!-- doxytag: member="pmsmDS::L_iu" ref="7ec5b692e1be1623a08196ac2da7b56b" args="" -->
140int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_iu</b></td></tr>
141
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da06f9ce4decceb05a03371d054a1583"></a><!-- doxytag: member="pmsmDS::L_optu" ref="da06f9ce4decceb05a03371d054a1583" args="" -->
143int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_optu</b></td></tr>
144
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba6fbc63e4353135857bbba8f30e3012"></a><!-- doxytag: member="pmsmDS::profileWw" ref="ba6fbc63e4353135857bbba8f30e3012" args="" -->
146vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#ba6fbc63e4353135857bbba8f30e3012">profileWw</a></td></tr>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Setpoints of omega in timespans given by dt_prof. <br></td></tr>
149<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="817e0b4c12e2c185271740b3ce3e3980"></a><!-- doxytag: member="pmsmDS::profileMz" ref="817e0b4c12e2c185271740b3ce3e3980" args="" -->
150vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#817e0b4c12e2c185271740b3ce3e3980">profileMz</a></td></tr>
151
152<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Setpoints of Mz in timespans given by dt_prof. <br></td></tr>
153<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01d9d15490d336b6613368557608f4fe"></a><!-- doxytag: member="pmsmDS::dt_prof" ref="01d9d15490d336b6613368557608f4fe" args="" -->
154double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#01d9d15490d336b6613368557608f4fe">dt_prof</a></td></tr>
155
156<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">time-step for profiles <br></td></tr>
157<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c27956dc82ede2e8dbeb34e6cfa15a40"></a><!-- doxytag: member="pmsmDS::Dt" ref="c27956dc82ede2e8dbeb34e6cfa15a40" args="" -->
158int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#c27956dc82ede2e8dbeb34e6cfa15a40">Dt</a></td></tr>
159
160<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of miliseconds per discrete time step. <br></td></tr>
161<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f387fee363e4a8492074fee36bb8421b"></a><!-- doxytag: member="pmsmDS::opt_modu" ref="f387fee363e4a8492074fee36bb8421b" args="" -->
162bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#f387fee363e4a8492074fee36bb8421b">opt_modu</a></td></tr>
163
164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">options for logging, - log predictions of 'true' voltage <br></td></tr>
165<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="pmsmDS::dtsize" ref="f96cae44624e79638a91ec4f2c7c81a9" args="" -->
166int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr>
167
168<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="pmsmDS::utsize" ref="d7467046a0bd05bc992cc5e1bdedb983" args="" -->
169int&nbsp;</td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr>
170
171<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="pmsmDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
172RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#d8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
173
174<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>
175<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="pmsmDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
176RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
177
178<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>
179<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="pmsmDS::L_dt" ref="b4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
180int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#b4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
181
182<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br></td></tr>
183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="pmsmDS::L_ut" ref="b56b74ec21485846ccfad461f33b0e7a" args="" -->
184int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
185
186</table>
187<hr><a name="_details"></a><h2>Detailed Description</h2>
188Simulator of PMSM machine with predefined profile on omega. <hr><h2>Constructor &amp; Destructor Documentation</h2>
189<a class="anchor" name="e6a50a246de039f30cb5423521aab55c"></a><!-- doxytag: member="pmsmDS::pmsmDS" ref="e6a50a246de039f30cb5423521aab55c" args="()" -->
190<div class="memitem">
191<div class="memproto">
192      <table class="memname">
193        <tr>
194          <td class="memname">pmsmDS::pmsmDS           </td>
195          <td>(</td>
196          <td class="paramname">          </td>
197          <td>&nbsp;)&nbsp;</td>
198          <td><code> [inline]</code></td>
199        </tr>
200      </table>
201</div>
202<div class="memdoc">
203
204<p>
205options for logging, -
206<p>
207Constructor with fixed sampling period
208<p>References <a class="el" href="libBM_8h-source.html#l00566">bdm::DS::Drv</a>, and <a class="el" href="pmsmDS_8h-source.html#l00031">Dt</a>.</p>
209
210</div>
211</div><p>
212<hr>The documentation for this class was generated from the following file:<ul>
213<li><a class="el" href="pmsmDS_8h-source.html">pmsmDS.h</a></ul>
214</div>
215<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 23 21:06:44 2009 for mixpp by&nbsp;
216<a href="http://www.doxygen.org/index.html">
217<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
218</body>
219</html>
Note: See TracBrowser for help on using the browser.