root/doc/latex/classpmsmDS.tex @ 280

Revision 280, 7.9 kB (checked in by smidl, 16 years ago)

progress...

Line 
1\hypertarget{classpmsmDS}{
2\section{pmsmDS Class Reference}
3\label{classpmsmDS}\index{pmsmDS@{pmsmDS}}
4}
5{\tt \#include $<$pmsmDS.h$>$}
6
7Inheritance diagram for pmsmDS::\begin{figure}[H]
8\begin{center}
9\leavevmode
10\includegraphics[height=3cm]{classpmsmDS}
11\end{center}
12\end{figure}
13
14
15\subsection{Detailed Description}
16Simulator of PMSM machine with predefined profile on omega. \subsection*{Public Member Functions}
17\begin{CompactItemize}
18\item 
19\hypertarget{classpmsmDS_38803dee6cc0bf261d277a225bca48cf}{
20\hyperlink{classpmsmDS_38803dee6cc0bf261d277a225bca48cf}{pmsmDS} (string opt0=\char`\"{}\char`\"{})}
21\label{classpmsmDS_38803dee6cc0bf261d277a225bca48cf}
22
23\begin{CompactList}\small\item\em Constructor with fixed sampling period. \item\end{CompactList}\item 
24\hypertarget{classpmsmDS_73073ee4f905af3f9f96a6130e9a9e22}{
25void \textbf{set\_\-parameters} (double Rs0, double Ls0, double Fmag0, double Bf0, double p0, double kp0, double J0, double Uc0, double DT0, double dt0)}
26\label{classpmsmDS_73073ee4f905af3f9f96a6130e9a9e22}
27
28\item 
29\hypertarget{classpmsmDS_4e47e678eb56e0b3bd47d801d0995e46}{
30void \hyperlink{classpmsmDS_4e47e678eb56e0b3bd47d801d0995e46}{getdata} (vec \&dt)}
31\label{classpmsmDS_4e47e678eb56e0b3bd47d801d0995e46}
32
33\begin{CompactList}\small\item\em Returns full vector of observed data=\mbox{[}output, input\mbox{]}. \item\end{CompactList}\item 
34\hypertarget{classpmsmDS_35e9a2b9d82bd1b71d66778021d1e8b4}{
35void \hyperlink{classpmsmDS_35e9a2b9d82bd1b71d66778021d1e8b4}{write} (vec \&ut)}
36\label{classpmsmDS_35e9a2b9d82bd1b71d66778021d1e8b4}
37
38\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
39\hypertarget{classpmsmDS_664fc8deff7c141ee7ab826a9abb387b}{
40void \hyperlink{classpmsmDS_664fc8deff7c141ee7ab826a9abb387b}{step} ()}
41\label{classpmsmDS_664fc8deff7c141ee7ab826a9abb387b}
42
43\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 
44\hypertarget{classpmsmDS_d75b83468db25c56977ffccff46b0b37}{
45void \hyperlink{classpmsmDS_d75b83468db25c56977ffccff46b0b37}{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
46\label{classpmsmDS_d75b83468db25c56977ffccff46b0b37}
47
48\begin{CompactList}\small\item\em Register DS for logging into logger L. \item\end{CompactList}\item 
49\hypertarget{classpmsmDS_21cac6deaac2dd073c982d7bec839b47}{
50void \hyperlink{classpmsmDS_21cac6deaac2dd073c982d7bec839b47}{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
51\label{classpmsmDS_21cac6deaac2dd073c982d7bec839b47}
52
53\begin{CompactList}\small\item\em Register DS for logging into logger L. \item\end{CompactList}\item 
54\hypertarget{classpmsmDS_60d213a13fd9c3b4ac9e8202ca5d772e}{
55void \textbf{set\_\-profile} (double dt, const vec \&Ww)}
56\label{classpmsmDS_60d213a13fd9c3b4ac9e8202ca5d772e}
57
58\item 
59\hypertarget{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}{
60virtual void \hyperlink{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}{getdata} (vec \&dt, const ivec \&indeces)}
61\label{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}
62
63\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
64\hypertarget{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{
65virtual void \hyperlink{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{write} (vec \&ut, const ivec \&indeces)}
66\label{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}
67
68\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
69\hypertarget{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{
70virtual RV \hyperlink{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{\_\-drv} () const }
71\label{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}
72
73\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
74\hypertarget{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{
75const RV \& \hyperlink{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{\_\-urv} () const }
76\label{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}
77
78\begin{CompactList}\small\item\em access function \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_f96cae44624e79638a91ec4f2c7c81a9}{
125int \textbf{dtsize}}
126\label{classbdm_1_1DS_f96cae44624e79638a91ec4f2c7c81a9}
127
128\item 
129\hypertarget{classbdm_1_1DS_d7467046a0bd05bc992cc5e1bdedb983}{
130int \textbf{utsize}}
131\label{classbdm_1_1DS_d7467046a0bd05bc992cc5e1bdedb983}
132
133\item 
134\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
135RV \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
136\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}
137
138\begin{CompactList}\small\item\em Description of data returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
139\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
140RV \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
141\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}
142
143\begin{CompactList}\small\item\em Description of data witten by by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\item 
144\hypertarget{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{
145int \hyperlink{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{L\_\-dt}}
146\label{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}
147
148\begin{CompactList}\small\item\em Remember its own index in Logger L. \item\end{CompactList}\item 
149\hypertarget{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}{
150int \textbf{L\_\-ut}}
151\label{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}
152
153\end{CompactItemize}
154
155
156\subsection{Member Data Documentation}
157\hypertarget{classpmsmDS_d410b9ca1a362e50a0833ae67803b7ee}{
158\index{pmsmDS@{pmsmDS}!opt@{opt}}
159\index{opt@{opt}!pmsmDS@{pmsmDS}}
160\subsubsection[opt]{\setlength{\rightskip}{0pt plus 5cm}string {\bf pmsmDS::opt}\hspace{0.3cm}{\tt  \mbox{[}protected\mbox{]}}}}
161\label{classpmsmDS_d410b9ca1a362e50a0833ae67803b7ee}
162
163
164options for logging, string in which each character has a meaning: {\tt u} - log predictions of 'true' voltage
165
166Referenced by log\_\-add(), and logit().
167
168The documentation for this class was generated from the following file:\begin{CompactItemize}
169\item 
170\hyperlink{pmsmDS_8h}{pmsmDS.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.