root/doc/latex/classpmsmDS.tex @ 261

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

doc

RevLine 
[261]1\hypertarget{classpmsmDS}{
2\section{pmsmDS Class Reference}
3\label{classpmsmDS}\index{pmsmDS@{pmsmDS}}
4}
5Simulator of PMSM machine with predefined profile on omega. 
6
7
8{\tt \#include $<$pmsmDS.h$>$}
9
10Inheritance diagram for pmsmDS:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=64pt]{classpmsmDS__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for pmsmDS:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=85pt]{classpmsmDS__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classpmsmDS_38803dee6cc0bf261d277a225bca48cf}{
28\hyperlink{classpmsmDS_38803dee6cc0bf261d277a225bca48cf}{pmsmDS} (string opt0=\char`\"{}\char`\"{})}
29\label{classpmsmDS_38803dee6cc0bf261d277a225bca48cf}
30
31\begin{CompactList}\small\item\em Constructor with fixed sampling period. \item\end{CompactList}\item 
32\hypertarget{classpmsmDS_73073ee4f905af3f9f96a6130e9a9e22}{
33void \textbf{set\_\-parameters} (double Rs0, double Ls0, double Fmag0, double Bf0, double p0, double kp0, double J0, double Uc0, double DT0, double dt0)}
34\label{classpmsmDS_73073ee4f905af3f9f96a6130e9a9e22}
35
36\item 
37\hypertarget{classpmsmDS_4e47e678eb56e0b3bd47d801d0995e46}{
38void \hyperlink{classpmsmDS_4e47e678eb56e0b3bd47d801d0995e46}{getdata} (vec \&dt)}
39\label{classpmsmDS_4e47e678eb56e0b3bd47d801d0995e46}
40
41\begin{CompactList}\small\item\em Returns full vector of observed data. \item\end{CompactList}\item 
42\hypertarget{classpmsmDS_35e9a2b9d82bd1b71d66778021d1e8b4}{
43void \hyperlink{classpmsmDS_35e9a2b9d82bd1b71d66778021d1e8b4}{write} (vec \&ut)}
44\label{classpmsmDS_35e9a2b9d82bd1b71d66778021d1e8b4}
45
46\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
47\hypertarget{classpmsmDS_664fc8deff7c141ee7ab826a9abb387b}{
48void \hyperlink{classpmsmDS_664fc8deff7c141ee7ab826a9abb387b}{step} ()}
49\label{classpmsmDS_664fc8deff7c141ee7ab826a9abb387b}
50
51\begin{CompactList}\small\item\em Moves from $t$ to $t+1$, i.e. perfroms the actions and reads response of the system. \item\end{CompactList}\item 
52\hypertarget{classpmsmDS_d75b83468db25c56977ffccff46b0b37}{
53void \textbf{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
54\label{classpmsmDS_d75b83468db25c56977ffccff46b0b37}
55
56\item 
57\hypertarget{classpmsmDS_21cac6deaac2dd073c982d7bec839b47}{
58void \textbf{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
59\label{classpmsmDS_21cac6deaac2dd073c982d7bec839b47}
60
61\item 
62\hypertarget{classpmsmDS_60d213a13fd9c3b4ac9e8202ca5d772e}{
63void \textbf{set\_\-profile} (double dt, const vec \&Ww)}
64\label{classpmsmDS_60d213a13fd9c3b4ac9e8202ca5d772e}
65
66\item 
67\hypertarget{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}{
68virtual void \hyperlink{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}{getdata} (vec \&dt, const ivec \&indeces)}
69\label{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}
70
71\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
72\hypertarget{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{
73virtual void \hyperlink{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{write} (vec \&ut, const ivec \&indeces)}
74\label{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}
75
76\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
77virtual void \hyperlink{classbdm_1_1DS_d41210a809d312621ab2c0b1ed3bfc1a}{linkrvs} (RV \&drv, RV \&urv)
78\begin{CompactList}\small\item\em 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. \item\end{CompactList}\end{CompactItemize}
79\subsection*{Protected Attributes}
80\begin{CompactItemize}
81\item 
82\hypertarget{classpmsmDS_3975e648cc981a550997df8120e176f7}{
83int \hyperlink{classpmsmDS_3975e648cc981a550997df8120e176f7}{L\_\-x}}
84\label{classpmsmDS_3975e648cc981a550997df8120e176f7}
85
86\begin{CompactList}\small\item\em indeces of logged variables \item\end{CompactList}\item 
87\hypertarget{classpmsmDS_a45b0843888a7c7675a264953814d9c2}{
88int \textbf{L\_\-ou}}
89\label{classpmsmDS_a45b0843888a7c7675a264953814d9c2}
90
91\item 
92\hypertarget{classpmsmDS_4fe8c4c1994547875973492bf3c909dd}{
93int \textbf{L\_\-oy}}
94\label{classpmsmDS_4fe8c4c1994547875973492bf3c909dd}
95
96\item 
97\hypertarget{classpmsmDS_7ec5b692e1be1623a08196ac2da7b56b}{
98int \textbf{L\_\-iu}}
99\label{classpmsmDS_7ec5b692e1be1623a08196ac2da7b56b}
100
101\item 
102\hypertarget{classpmsmDS_da06f9ce4decceb05a03371d054a1583}{
103int \textbf{L\_\-optu}}
104\label{classpmsmDS_da06f9ce4decceb05a03371d054a1583}
105
106\item 
107\hypertarget{classpmsmDS_ba6fbc63e4353135857bbba8f30e3012}{
108vec \hyperlink{classpmsmDS_ba6fbc63e4353135857bbba8f30e3012}{profileWw}}
109\label{classpmsmDS_ba6fbc63e4353135857bbba8f30e3012}
110
111\begin{CompactList}\small\item\em Setpoints of omega in timespans given by dt\_\-prof. \item\end{CompactList}\item 
112\hypertarget{classpmsmDS_01d9d15490d336b6613368557608f4fe}{
113double \hyperlink{classpmsmDS_01d9d15490d336b6613368557608f4fe}{dt\_\-prof}}
114\label{classpmsmDS_01d9d15490d336b6613368557608f4fe}
115
116\begin{CompactList}\small\item\em time-step for profiles \item\end{CompactList}\item 
117\hypertarget{classpmsmDS_c27956dc82ede2e8dbeb34e6cfa15a40}{
118int \hyperlink{classpmsmDS_c27956dc82ede2e8dbeb34e6cfa15a40}{Dt}}
119\label{classpmsmDS_c27956dc82ede2e8dbeb34e6cfa15a40}
120
121\begin{CompactList}\small\item\em Number of miliseconds per discrete time step. \item\end{CompactList}\item 
122string \hyperlink{classpmsmDS_d410b9ca1a362e50a0833ae67803b7ee}{opt}
123\item 
124\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
125RV \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
126\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}
127
128\begin{CompactList}\small\item\em Observed variables, returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
129\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
130RV \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
131\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}
132
133\begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\end{CompactItemize}
134
135
136\subsection{Detailed Description}
137Simulator of PMSM machine with predefined profile on omega.
138
139\subsection{Member Function Documentation}
140\hypertarget{classbdm_1_1DS_d41210a809d312621ab2c0b1ed3bfc1a}{
141\index{pmsmDS@{pmsmDS}!linkrvs@{linkrvs}}
142\index{linkrvs@{linkrvs}!pmsmDS@{pmsmDS}}
143\subsubsection[linkrvs]{\setlength{\rightskip}{0pt plus 5cm}virtual void bdm::DS::linkrvs ({\bf RV} \& {\em drv}, \/  {\bf RV} \& {\em urv})\hspace{0.3cm}{\tt  \mbox{[}virtual, inherited\mbox{]}}}}
144\label{classbdm_1_1DS_d41210a809d312621ab2c0b1ed3bfc1a}
145
146
147Method 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.
148
149(Inherited from m3k, may be deprecated soon).
150
151Reimplemented in \hyperlink{classbdm_1_1MemDS_5f72b555e0e4a61de1440c457cf57007}{bdm::MemDS}.
152
153\subsection{Member Data Documentation}
154\hypertarget{classpmsmDS_d410b9ca1a362e50a0833ae67803b7ee}{
155\index{pmsmDS@{pmsmDS}!opt@{opt}}
156\index{opt@{opt}!pmsmDS@{pmsmDS}}
157\subsubsection[opt]{\setlength{\rightskip}{0pt plus 5cm}string {\bf pmsmDS::opt}\hspace{0.3cm}{\tt  \mbox{[}protected\mbox{]}}}}
158\label{classpmsmDS_d410b9ca1a362e50a0833ae67803b7ee}
159
160
161options for logging, string in which each character has a meaning: {\tt u} - log predictions of 'true' voltage
162
163The documentation for this class was generated from the following file:\begin{CompactItemize}
164\item 
165\hyperlink{pmsmDS_8h}{pmsmDS.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.