root/doc/latex/classbdm_1_1datalink__e2e.tex @ 261

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

doc

Line 
1\hypertarget{classbdm_1_1datalink__e2e}{
2\section{bdm::datalink\_\-e2e Class Reference}
3\label{classbdm_1_1datalink__e2e}\index{bdm::datalink\_\-e2e@{bdm::datalink\_\-e2e}}
4}
5DataLink is a connection between two data vectors Up and Down. 
6
7
8{\tt \#include $<$libBM.h$>$}
9
10Inheritance diagram for bdm::datalink\_\-e2e:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=78pt]{classbdm_1_1datalink__e2e__inherit__graph}
15\end{center}
16\end{figure}
17\subsection*{Public Member Functions}
18\begin{CompactItemize}
19\item 
20\hypertarget{classbdm_1_1datalink__e2e_c85912b85a0a47ff0931d07e2d653264}{
21\hyperlink{classbdm_1_1datalink__e2e_c85912b85a0a47ff0931d07e2d653264}{datalink\_\-e2e} (const \hyperlink{classbdm_1_1RV}{RV} \&rv, const \hyperlink{classbdm_1_1RV}{RV} \&rv\_\-up)}
22\label{classbdm_1_1datalink__e2e_c85912b85a0a47ff0931d07e2d653264}
23
24\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
25\hypertarget{classbdm_1_1datalink__e2e_4938c157340dc0dbc8f7bd3491678d86}{
26vec \hyperlink{classbdm_1_1datalink__e2e_4938c157340dc0dbc8f7bd3491678d86}{get\_\-val} (const vec \&val\_\-up)}
27\label{classbdm_1_1datalink__e2e_4938c157340dc0dbc8f7bd3491678d86}
28
29\begin{CompactList}\small\item\em Get val for myself from val of \char`\"{}Up\char`\"{}. \item\end{CompactList}\item 
30\hypertarget{classbdm_1_1datalink__e2e_7646ec2f0f83bee2852e0fae6b0756a2}{
31void \hyperlink{classbdm_1_1datalink__e2e_7646ec2f0f83bee2852e0fae6b0756a2}{fill\_\-val} (vec \&val\_\-up, const vec \&val)}
32\label{classbdm_1_1datalink__e2e_7646ec2f0f83bee2852e0fae6b0756a2}
33
34\begin{CompactList}\small\item\em Fill val of \char`\"{}Up\char`\"{} by my pieces. \item\end{CompactList}\end{CompactItemize}
35\subsection*{Protected Attributes}
36\begin{CompactItemize}
37\item 
38\hypertarget{classbdm_1_1datalink__e2e_eb4ee03764c2531083ec19759b7a52d3}{
39int \hyperlink{classbdm_1_1datalink__e2e_eb4ee03764c2531083ec19759b7a52d3}{valsize}}
40\label{classbdm_1_1datalink__e2e_eb4ee03764c2531083ec19759b7a52d3}
41
42\begin{CompactList}\small\item\em Remember how long val should be. \item\end{CompactList}\item 
43\hypertarget{classbdm_1_1datalink__e2e_ed0830e7a13f4f0f4beaae939cf11f6b}{
44int \hyperlink{classbdm_1_1datalink__e2e_ed0830e7a13f4f0f4beaae939cf11f6b}{valupsize}}
45\label{classbdm_1_1datalink__e2e_ed0830e7a13f4f0f4beaae939cf11f6b}
46
47\begin{CompactList}\small\item\em Remember how long val of \char`\"{}Up\char`\"{} should be. \item\end{CompactList}\item 
48\hypertarget{classbdm_1_1datalink__e2e_fa38045c8f1230757d62d38e71a49b97}{
49ivec \hyperlink{classbdm_1_1datalink__e2e_fa38045c8f1230757d62d38e71a49b97}{v2v\_\-up}}
50\label{classbdm_1_1datalink__e2e_fa38045c8f1230757d62d38e71a49b97}
51
52\begin{CompactList}\small\item\em val-to-val link, indeces of the upper val \item\end{CompactList}\end{CompactItemize}
53
54
55\subsection{Detailed Description}
56DataLink is a connection between two data vectors Up and Down.
57
58Up can be longer than Down. Down must be fully present in Up (TODO optional) See chart: \begin{center}
59\begin{ImageNoCaption}\mbox{\includegraphics{inline_dotgraph_1}}
60\end{ImageNoCaption}
61\end{center}
62 
63
64The documentation for this class was generated from the following file:\begin{CompactItemize}
65\item 
66\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.