Show
Ignore:
Timestamp:
02/24/09 14:12:46 (16 years ago)
Author:
smidl
Message:

progress...

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/latex/classpmsmDS.tex

    r261 r280  
    33\label{classpmsmDS}\index{pmsmDS@{pmsmDS}} 
    44} 
    5 Simulator of PMSM machine with predefined profile on omega.   
     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} 
    613 
    714 
    8 {\tt \#include $<$pmsmDS.h$>$} 
    9  
    10 Inheritance 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} 
    17 Collaboration 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} 
     15\subsection{Detailed Description} 
     16Simulator of PMSM machine with predefined profile on omega. \subsection*{Public Member Functions} 
    2517\begin{CompactItemize} 
    2618\item  
    … …  
    3931\label{classpmsmDS_4e47e678eb56e0b3bd47d801d0995e46} 
    4032 
    41 \begin{CompactList}\small\item\em Returns full vector of observed data. \item\end{CompactList}\item  
     33\begin{CompactList}\small\item\em Returns full vector of observed data=\mbox{[}output, input\mbox{]}. \item\end{CompactList}\item  
    4234\hypertarget{classpmsmDS_35e9a2b9d82bd1b71d66778021d1e8b4}{ 
    4335void \hyperlink{classpmsmDS_35e9a2b9d82bd1b71d66778021d1e8b4}{write} (vec \&ut)} 
    … …  
    4941\label{classpmsmDS_664fc8deff7c141ee7ab826a9abb387b} 
    5042 
    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  
     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  
    5244\hypertarget{classpmsmDS_d75b83468db25c56977ffccff46b0b37}{ 
    53 void \textbf{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)} 
     45void \hyperlink{classpmsmDS_d75b83468db25c56977ffccff46b0b37}{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)} 
    5446\label{classpmsmDS_d75b83468db25c56977ffccff46b0b37} 
    5547 
    56 \item  
     48\begin{CompactList}\small\item\em Register DS for logging into logger L. \item\end{CompactList}\item  
    5749\hypertarget{classpmsmDS_21cac6deaac2dd073c982d7bec839b47}{ 
    58 void \textbf{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)} 
     50void \hyperlink{classpmsmDS_21cac6deaac2dd073c982d7bec839b47}{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)} 
    5951\label{classpmsmDS_21cac6deaac2dd073c982d7bec839b47} 
    6052 
    61 \item  
     53\begin{CompactList}\small\item\em Register DS for logging into logger L. \item\end{CompactList}\item  
    6254\hypertarget{classpmsmDS_60d213a13fd9c3b4ac9e8202ca5d772e}{ 
    6355void \textbf{set\_\-profile} (double dt, const vec \&Ww)} 
    … …  
    7567 
    7668\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item  
    77 virtual 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} 
     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} 
    7979\subsection*{Protected Attributes} 
    8080\begin{CompactItemize} 
    … …  
    122122string \hyperlink{classpmsmDS_d410b9ca1a362e50a0833ae67803b7ee}{opt} 
    123123\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  
    124134\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{ 
    125135RV \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}} 
    126136\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec} 
    127137 
    128 \begin{CompactList}\small\item\em Observed variables, returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item  
     138\begin{CompactList}\small\item\em Description of data returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item  
    129139\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{ 
    130140RV \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}} 
    131141\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702} 
    132142 
    133 \begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\end{CompactItemize} 
     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} 
    134147 
     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} 
    135152 
    136 \subsection{Detailed Description} 
    137 Simulator of PMSM machine with predefined profile on omega.  
     153\end{CompactItemize} 
    138154 
    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  
    147 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.  
    148  
    149 (Inherited from m3k, may be deprecated soon).  
    150  
    151 Reimplemented in \hyperlink{classbdm_1_1MemDS_5f72b555e0e4a61de1440c457cf57007}{bdm::MemDS}. 
    152155 
    153156\subsection{Member Data Documentation} 
    … …  
    161164options for logging, string in which each character has a meaning: {\tt u} - log predictions of 'true' voltage  
    162165 
     166Referenced by log\_\-add(), and logit(). 
     167 
    163168The documentation for this class was generated from the following file:\begin{CompactItemize} 
    164169\item