root/doc/html/classpmsmDS.html @ 261

Revision 261, 15.3 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[259]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="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
[261]14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
[259]16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
[261]21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
[259]22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27</div>
28<div class="contents">
29<h1>pmsmDS Class Reference</h1><!-- doxytag: class="pmsmDS" --><!-- doxytag: inherits="bdm::DS" -->Simulator of PMSM machine with predefined profile on omega. 
30<a href="#_details">More...</a>
31<p>
32<code>#include &lt;<a class="el" href="pmsmDS_8h-source.html">pmsmDS.h</a>&gt;</code>
33<p>
34<div class="dynheader">
35Inheritance diagram for pmsmDS:</div>
36<div class="dynsection">
37<p><center><img src="classpmsmDS__inherit__graph.png" border="0" usemap="#pmsmDS__inherit__map" alt="Inheritance graph"></center>
38<map name="pmsmDS__inherit__map">
[261]39<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="23,84,100,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
[259]40<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
41<div class="dynheader">
42Collaboration diagram for pmsmDS:</div>
43<div class="dynsection">
44<p><center><img src="classpmsmDS__coll__graph.png" border="0" usemap="#pmsmDS__coll__map" alt="Collaboration graph"></center>
45<map name="pmsmDS__coll__map">
[261]46<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="17,199,95,225"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="72,87,147,113"></map>
[259]47<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
48
49<p>
50<a href="classpmsmDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
51<tr><td></td></tr>
52<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
[261]53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38803dee6cc0bf261d277a225bca48cf"></a><!-- doxytag: member="pmsmDS::pmsmDS" ref="38803dee6cc0bf261d277a225bca48cf" args="(string opt0=&quot;&quot;)" -->
54&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#38803dee6cc0bf261d277a225bca48cf">pmsmDS</a> (string opt0=&quot;&quot;)</td></tr>
[259]55
[261]56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with fixed sampling period. <br></td></tr>
[259]57<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)" -->
58void&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>
59
60<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)" -->
61void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#4e47e678eb56e0b3bd47d801d0995e46">getdata</a> (vec &amp;dt)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data. <br></td></tr>
64<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)" -->
65void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#35e9a2b9d82bd1b71d66778021d1e8b4">write</a> (vec &amp;ut)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="664fc8deff7c141ee7ab826a9abb387b"></a><!-- doxytag: member="pmsmDS::step" ref="664fc8deff7c141ee7ab826a9abb387b" args="()" -->
69void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#664fc8deff7c141ee7ab826a9abb387b">step</a> ()</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$t$" src="form_38.png"> to <img class="formulaInl" alt="$t+1$" src="form_39.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr>
72<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)" -->
73void&nbsp;</td><td class="memItemRight" valign="bottom"><b>log_add</b> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
74
75<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)" -->
76void&nbsp;</td><td class="memItemRight" valign="bottom"><b>logit</b> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
77
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60d213a13fd9c3b4ac9e8202ca5d772e"></a><!-- doxytag: member="pmsmDS::set_profile" ref="60d213a13fd9c3b4ac9e8202ca5d772e" args="(double dt, const vec &amp;Ww)" -->
79void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_profile</b> (double dt, const vec &amp;Ww)</td></tr>
80
[261]81<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)" -->
82virtual 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>
[259]83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
[261]85<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)" -->
86virtual 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>
[259]87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
[261]89<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#d41210a809d312621ab2c0b1ed3bfc1a">linkrvs</a> (RV &amp;drv, RV &amp;urv)</td></tr>
[259]90
[261]91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method that assigns random variables to the datasource. Typically, the datasource will be constructed without knowledge of random variables. This method will associate existing variables with RVs.  <a href="#d41210a809d312621ab2c0b1ed3bfc1a"></a><br></td></tr>
[259]92<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3975e648cc981a550997df8120e176f7"></a><!-- doxytag: member="pmsmDS::L_x" ref="3975e648cc981a550997df8120e176f7" args="" -->
94int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#3975e648cc981a550997df8120e176f7">L_x</a></td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indeces of logged variables <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a45b0843888a7c7675a264953814d9c2"></a><!-- doxytag: member="pmsmDS::L_ou" ref="a45b0843888a7c7675a264953814d9c2" args="" -->
98int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ou</b></td></tr>
99
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4fe8c4c1994547875973492bf3c909dd"></a><!-- doxytag: member="pmsmDS::L_oy" ref="4fe8c4c1994547875973492bf3c909dd" args="" -->
101int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_oy</b></td></tr>
102
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ec5b692e1be1623a08196ac2da7b56b"></a><!-- doxytag: member="pmsmDS::L_iu" ref="7ec5b692e1be1623a08196ac2da7b56b" args="" -->
104int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_iu</b></td></tr>
105
[261]106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da06f9ce4decceb05a03371d054a1583"></a><!-- doxytag: member="pmsmDS::L_optu" ref="da06f9ce4decceb05a03371d054a1583" args="" -->
107int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_optu</b></td></tr>
108
[259]109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba6fbc63e4353135857bbba8f30e3012"></a><!-- doxytag: member="pmsmDS::profileWw" ref="ba6fbc63e4353135857bbba8f30e3012" args="" -->
110vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#ba6fbc63e4353135857bbba8f30e3012">profileWw</a></td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Setpoints of omega in timespans given by dt_prof. <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01d9d15490d336b6613368557608f4fe"></a><!-- doxytag: member="pmsmDS::dt_prof" ref="01d9d15490d336b6613368557608f4fe" args="" -->
114double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#01d9d15490d336b6613368557608f4fe">dt_prof</a></td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">time-step for profiles <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c27956dc82ede2e8dbeb34e6cfa15a40"></a><!-- doxytag: member="pmsmDS::Dt" ref="c27956dc82ede2e8dbeb34e6cfa15a40" args="" -->
118int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#c27956dc82ede2e8dbeb34e6cfa15a40">Dt</a></td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of miliseconds per discrete time step. <br></td></tr>
[261]121<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#d410b9ca1a362e50a0833ae67803b7ee">opt</a></td></tr>
122
[259]123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="pmsmDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
124RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#d8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
125
[261]126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observed variables, returned by <code><a class="el" href="classbdm_1_1DS.html#c1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data.">getdata()</a></code>. <br></td></tr>
[259]127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="pmsmDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
128RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
129
[261]130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action variables, accepted 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>
[259]131</table>
132<hr><a name="_details"></a><h2>Detailed Description</h2>
133Simulator of PMSM machine with predefined profile on omega. <hr><h2>Member Function Documentation</h2>
[261]134<a class="anchor" name="d41210a809d312621ab2c0b1ed3bfc1a"></a><!-- doxytag: member="pmsmDS::linkrvs" ref="d41210a809d312621ab2c0b1ed3bfc1a" args="(RV &amp;drv, RV &amp;urv)" -->
[259]135<div class="memitem">
136<div class="memproto">
137      <table class="memname">
138        <tr>
[261]139          <td class="memname">virtual void bdm::DS::linkrvs           </td>
[259]140          <td>(</td>
141          <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
142          <td class="paramname"> <em>drv</em>, </td>
143        </tr>
144        <tr>
145          <td class="paramkey"></td>
146          <td></td>
147          <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
148          <td class="paramname"> <em>urv</em></td><td>&nbsp;</td>
149        </tr>
150        <tr>
151          <td></td>
152          <td>)</td>
[261]153          <td></td><td></td><td><code> [virtual, inherited]</code></td>
[259]154        </tr>
155      </table>
156</div>
157<div class="memdoc">
158
159<p>
160Method that assigns random variables to the datasource. Typically, the datasource will be constructed without knowledge of random variables. This method will associate existing variables with RVs.
161<p>
162(Inherited from m3k, may be deprecated soon).
163<p>Reimplemented in <a class="el" href="classbdm_1_1MemDS.html#5f72b555e0e4a61de1440c457cf57007">bdm::MemDS</a>.</p>
164
165</div>
166</div><p>
[261]167<hr><h2>Member Data Documentation</h2>
168<a class="anchor" name="d410b9ca1a362e50a0833ae67803b7ee"></a><!-- doxytag: member="pmsmDS::opt" ref="d410b9ca1a362e50a0833ae67803b7ee" args="" -->
169<div class="memitem">
170<div class="memproto">
171      <table class="memname">
172        <tr>
173          <td class="memname">string <a class="el" href="classpmsmDS.html#d410b9ca1a362e50a0833ae67803b7ee">pmsmDS::opt</a><code> [protected]</code>          </td>
174        </tr>
175      </table>
176</div>
177<div class="memdoc">
178
179<p>
180options for logging, string in which each character has a meaning: <code>u</code> - log predictions of 'true' voltage
181</div>
182</div><p>
[259]183<hr>The documentation for this class was generated from the following file:<ul>
[261]184<li><a class="el" href="pmsmDS_8h-source.html">pmsmDS.h</a></ul>
[259]185</div>
[261]186<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 12:17:00 2009 for mixpp by&nbsp;
[259]187<a href="http://www.doxygen.org/index.html">
188<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
189</body>
190</html>
Note: See TracBrowser for help on using the browser.