root/doc/latex/classbdm_1_1datalink.tex @ 275

Revision 275, 3.5 kB (checked in by smidl, 16 years ago)

doc

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