root/doc/latex/classbdm_1_1DS.tex @ 261

\hypertarget{classbdm_1_1DS}{
\section{bdm::DS Class Reference}
\label{classbdm_1_1DS}\index{bdm::DS@{bdm::DS}}
}
Abstract class for discrete-time sources of data.  


{\tt \#include $<$libBM.h$>$}

Inheritance diagram for bdm::DS:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=109pt]{classbdm_1_1DS__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for bdm::DS:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=75pt]{classbdm_1_1DS__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1DS_bf34c9273f54cb706354fe81af3a9c1a}{
\textbf{DS} (const \hyperlink{classbdm_1_1RV}{RV} \&Drv0, const \hyperlink{classbdm_1_1RV}{RV} \&Urv0)}
\label{classbdm_1_1DS_bf34c9273f54cb706354fe81af3a9c1a}

\item 
\hypertarget{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{
virtual void \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata} (vec \&dt)}
\label{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}

\begin{CompactList}\small\item\em Returns full vector of observed data. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}{
virtual void \hyperlink{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}{getdata} (vec \&dt, const ivec \&indeces)}
\label{classbdm_1_1DS_a0bf451c7fea73ff4150ff9e83da4832}

\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{
virtual void \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write} (vec \&ut)}
\label{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}

\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{
virtual void \hyperlink{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{write} (vec \&ut, const ivec \&indeces)}
\label{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}

\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_9a14c64d881e838ddc3a5617ee8a973b}{
virtual void \hyperlink{classbdm_1_1DS_9a14c64d881e838ddc3a5617ee8a973b}{step} ()=0}
\label{classbdm_1_1DS_9a14c64d881e838ddc3a5617ee8a973b}

\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}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}

\begin{CompactList}\small\item\em Observed variables, returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}

\begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Abstract class for discrete-time sources of data. 

The 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). 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}