root/doc/html/classpmsmDS.html @ 259

Revision 259, 13.7 kB (checked in by smidl, 15 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="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>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<h1>pmsmDS Class Reference</h1><!-- doxytag: class="pmsmDS" --><!-- doxytag: inherits="bdm::DS" -->Simulator of PMSM machine with predefined profile on omega. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="pmsmDS_8h-source.html">pmsmDS.h</a>&gt;</code>
31<p>
32<div class="dynheader">
33Inheritance diagram for pmsmDS:</div>
34<div class="dynsection">
35<p><center><img src="classpmsmDS__inherit__graph.png" border="0" usemap="#pmsmDS__inherit__map" alt="Inheritance graph"></center>
36<map name="pmsmDS__inherit__map">
37<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="7,7,84,33"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for pmsmDS:</div>
41<div class="dynsection">
42<p><center><img src="classpmsmDS__coll__graph.png" border="0" usemap="#pmsmDS__coll__map" alt="Collaboration graph"></center>
43<map name="pmsmDS__coll__map">
44<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="11,199,88,225"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="12,87,87,113"><area shape="rect" href="classbdm_1_1base.html" title="Root class of BDM objects." alt="" coords="5,7,93,33"></map>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classpmsmDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
49<tr><td></td></tr>
50<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3eb2dfe16e93e22a254f1a04f6aeb982"></a><!-- doxytag: member="pmsmDS::pmsmDS" ref="3eb2dfe16e93e22a254f1a04f6aeb982" args="(int Dt0)" -->
52&nbsp;</td><td class="memItemRight" valign="bottom"><b>pmsmDS</b> (int Dt0)</td></tr>
53
54<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)" -->
55void&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>
56
57<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)" -->
58void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#4e47e678eb56e0b3bd47d801d0995e46">getdata</a> (vec &amp;dt)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data. <br></td></tr>
61<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)" -->
62void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#35e9a2b9d82bd1b71d66778021d1e8b4">write</a> (vec &amp;ut)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="664fc8deff7c141ee7ab826a9abb387b"></a><!-- doxytag: member="pmsmDS::step" ref="664fc8deff7c141ee7ab826a9abb387b" args="()" -->
66void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#664fc8deff7c141ee7ab826a9abb387b">step</a> ()</td></tr>
67
68<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>
69<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)" -->
70void&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>
71
72<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)" -->
73void&nbsp;</td><td class="memItemRight" valign="bottom"><b>logit</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="60d213a13fd9c3b4ac9e8202ca5d772e"></a><!-- doxytag: member="pmsmDS::set_profile" ref="60d213a13fd9c3b4ac9e8202ca5d772e" args="(double dt, const vec &amp;Ww)" -->
76void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_profile</b> (double dt, const vec &amp;Ww)</td></tr>
77
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78b6b53e58c0759a673138117aba03d1"></a><!-- doxytag: member="pmsmDS::getdata" ref="78b6b53e58c0759a673138117aba03d1" args="(vec &amp;dt, ivec &amp;indeces)" -->
79void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#78b6b53e58c0759a673138117aba03d1">getdata</a> (vec &amp;dt, ivec &amp;indeces)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87a8b6284611b008c8aadb7235f1939a"></a><!-- doxytag: member="pmsmDS::write" ref="87a8b6284611b008c8aadb7235f1939a" args="(vec &amp;ut, ivec &amp;indeces)" -->
83void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#87a8b6284611b008c8aadb7235f1939a">write</a> (vec &amp;ut, ivec &amp;indeces)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#edd136e9046c08ac615cbe3c741de21e">linkrvs</a> (RV &amp;drv, RV &amp;urv)</td></tr>
87
88<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="#edd136e9046c08ac615cbe3c741de21e"></a><br></td></tr>
89<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3975e648cc981a550997df8120e176f7"></a><!-- doxytag: member="pmsmDS::L_x" ref="3975e648cc981a550997df8120e176f7" args="" -->
91int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#3975e648cc981a550997df8120e176f7">L_x</a></td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indeces of logged variables <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a45b0843888a7c7675a264953814d9c2"></a><!-- doxytag: member="pmsmDS::L_ou" ref="a45b0843888a7c7675a264953814d9c2" args="" -->
95int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ou</b></td></tr>
96
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4fe8c4c1994547875973492bf3c909dd"></a><!-- doxytag: member="pmsmDS::L_oy" ref="4fe8c4c1994547875973492bf3c909dd" args="" -->
98int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_oy</b></td></tr>
99
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ec5b692e1be1623a08196ac2da7b56b"></a><!-- doxytag: member="pmsmDS::L_iu" ref="7ec5b692e1be1623a08196ac2da7b56b" args="" -->
101int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_iu</b></td></tr>
102
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba6fbc63e4353135857bbba8f30e3012"></a><!-- doxytag: member="pmsmDS::profileWw" ref="ba6fbc63e4353135857bbba8f30e3012" args="" -->
104vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#ba6fbc63e4353135857bbba8f30e3012">profileWw</a></td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Setpoints of omega in timespans given by dt_prof. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01d9d15490d336b6613368557608f4fe"></a><!-- doxytag: member="pmsmDS::dt_prof" ref="01d9d15490d336b6613368557608f4fe" args="" -->
108double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#01d9d15490d336b6613368557608f4fe">dt_prof</a></td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">time-step for profiles <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c27956dc82ede2e8dbeb34e6cfa15a40"></a><!-- doxytag: member="pmsmDS::Dt" ref="c27956dc82ede2e8dbeb34e6cfa15a40" args="" -->
112int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpmsmDS.html#c27956dc82ede2e8dbeb34e6cfa15a40">Dt</a></td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of miliseconds per discrete time step. <br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="pmsmDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
116RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#d8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observed variables, returned by <code><a class="el" href="classbdm_1_1DS.html#cbffe794e02eb88b5856b83119b7c23c" title="Returns full vector of observed data.">getdata()</a></code>. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="pmsmDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
120RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action variables, accepted by <code><a class="el" href="classbdm_1_1DS.html#653a30e5bb76fb231429dae52216c851" title="Accepts action variable and schedule it for application.">write()</a></code>. <br></td></tr>
123</table>
124<hr><a name="_details"></a><h2>Detailed Description</h2>
125Simulator of PMSM machine with predefined profile on omega. <hr><h2>Member Function Documentation</h2>
126<a class="anchor" name="edd136e9046c08ac615cbe3c741de21e"></a><!-- doxytag: member="pmsmDS::linkrvs" ref="edd136e9046c08ac615cbe3c741de21e" args="(RV &amp;drv, RV &amp;urv)" -->
127<div class="memitem">
128<div class="memproto">
129      <table class="memname">
130        <tr>
131          <td class="memname">void bdm::DS::linkrvs           </td>
132          <td>(</td>
133          <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
134          <td class="paramname"> <em>drv</em>, </td>
135        </tr>
136        <tr>
137          <td class="paramkey"></td>
138          <td></td>
139          <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
140          <td class="paramname"> <em>urv</em></td><td>&nbsp;</td>
141        </tr>
142        <tr>
143          <td></td>
144          <td>)</td>
145          <td></td><td></td><td><code> [inherited]</code></td>
146        </tr>
147      </table>
148</div>
149<div class="memdoc">
150
151<p>
152Method 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.
153<p>
154(Inherited from m3k, may be deprecated soon).
155<p>Reimplemented in <a class="el" href="classbdm_1_1MemDS.html#5f72b555e0e4a61de1440c457cf57007">bdm::MemDS</a>.</p>
156
157</div>
158</div><p>
159<hr>The documentation for this class was generated from the following file:<ul>
160<li>work/git/mixpp/pmsm/<a class="el" href="pmsmDS_8h-source.html">pmsmDS.h</a></ul>
161</div>
162<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 27 16:30:35 2009 for mixpp by&nbsp;
163<a href="http://www.doxygen.org/index.html">
164<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
165</body>
166</html>
Note: See TracBrowser for help on using the browser.