root/doc/latex/classbdm_1_1DS.tex @ 269

Revision 269, 5.7 kB (checked in by smidl, 16 years ago)

doc

Line 
1\hypertarget{classbdm_1_1DS}{
2\section{bdm::DS Class Reference}
3\label{classbdm_1_1DS}\index{bdm::DS@{bdm::DS}}
4}
5Abstract class for discrete-time sources of data. 
6
7
8{\tt \#include $<$libBM.h$>$}
9
10Inheritance diagram for bdm::DS:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=159pt]{classbdm_1_1DS__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::DS:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=75pt]{classbdm_1_1DS__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1DS_bf34c9273f54cb706354fe81af3a9c1a}{
28\textbf{DS} (const \hyperlink{classbdm_1_1RV}{RV} \&Drv0, const \hyperlink{classbdm_1_1RV}{RV} \&Urv0)}
29\label{classbdm_1_1DS_bf34c9273f54cb706354fe81af3a9c1a}
30
31\item 
32\hypertarget{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{
33virtual void \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata} (vec \&dt)}
34\label{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}
35
36\begin{CompactList}\small\item\em Returns full vector of observed data=\mbox{[}output, input\mbox{]}. \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}{
38virtual void \hyperlink{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}{getdata} (vec \&dt, const ivec \&indeces)}
39\label{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}
40
41\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
42\hypertarget{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{
43virtual void \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write} (vec \&ut)}
44\label{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}
45
46\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
47\hypertarget{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{
48virtual void \hyperlink{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{write} (vec \&ut, const ivec \&indeces)}
49\label{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}
50
51\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
52\hypertarget{classbdm_1_1DS_9a14c64d881e838ddc3a5617ee8a973b}{
53virtual void \hyperlink{classbdm_1_1DS_9a14c64d881e838ddc3a5617ee8a973b}{step} ()=0}
54\label{classbdm_1_1DS_9a14c64d881e838ddc3a5617ee8a973b}
55
56\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 
57\hypertarget{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}{
58virtual void \hyperlink{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
59\label{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}
60
61\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
62\hypertarget{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}{
63virtual void \hyperlink{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
64\label{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}
65
66\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
67\hypertarget{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{
68virtual \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{\_\-drv} () const }
69\label{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}
70
71\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
72\hypertarget{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{
73const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{\_\-urv} () const }
74\label{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}
75
76\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
77\subsection*{Protected Attributes}
78\begin{CompactItemize}
79\item 
80\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
81\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
82\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}
83
84\begin{CompactList}\small\item\em Observed variables, returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
85\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
86\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
87\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}
88
89\begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\item 
90\hypertarget{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{
91int \hyperlink{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{L\_\-dt}}
92\label{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}
93
94\begin{CompactList}\small\item\em Remember its own index in Logger L. \item\end{CompactList}\item 
95\hypertarget{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}{
96int \textbf{L\_\-ut}}
97\label{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}
98
99\end{CompactItemize}
100
101
102\subsection{Detailed Description}
103Abstract class for discrete-time sources of data.
104
105The class abstracts operations of: (i) data aquisition, (ii) data-preprocessing, (iii) scaling of data, and (iv) data resampling from the task of estimation and control. Moreover, for controlled systems, it is able to receive the desired control action and perform it in the next step. (Or as soon as possible).
106
107The documentation for this class was generated from the following file:\begin{CompactItemize}
108\item 
109\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.