root/doc/latex/classcompositepdf.tex @ 192

Revision 187, 4.5 kB (checked in by smidl, 16 years ago)

doc

Line 
1\hypertarget{classcompositepdf}{
2\section{compositepdf Class Reference}
3\label{classcompositepdf}\index{compositepdf@{compositepdf}}
4}
5Abstract composition of pdfs, a base for specific classes. 
6
7
8{\tt \#include $<$libBM.h$>$}
9
10Inheritance diagram for compositepdf:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=80pt]{classcompositepdf__inherit__graph}
15\end{center}
16\end{figure}
17\subsection*{Public Member Functions}
18\begin{CompactItemize}
19\item 
20\hypertarget{classcompositepdf_6ab00575b058fcf4d80090cb3c95351d}{
21\textbf{compositepdf} (Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ A0)}
22\label{classcompositepdf_6ab00575b058fcf4d80090cb3c95351d}
23
24\item 
25\hyperlink{classRV}{RV} \hyperlink{classcompositepdf_635d219fb3e32852400d6f98aa4bdc93}{getrv} (bool checkoverlap=false)
26\begin{CompactList}\small\item\em find common rv, flag \item\end{CompactList}\item 
27\hypertarget{classcompositepdf_5a4479785c1fdb2cc351fbea07b899ac}{
28void \hyperlink{classcompositepdf_5a4479785c1fdb2cc351fbea07b899ac}{setrvc} (const \hyperlink{classRV}{RV} \&rv, \hyperlink{classRV}{RV} \&rvc)}
29\label{classcompositepdf_5a4479785c1fdb2cc351fbea07b899ac}
30
31\begin{CompactList}\small\item\em common rvc of all mpdfs is written to rvc \item\end{CompactList}\item 
32\hypertarget{classcompositepdf_08958c8f76d65de94ecc37b8d90bc77a}{
33void \hyperlink{classcompositepdf_08958c8f76d65de94ecc37b8d90bc77a}{setindices} (const \hyperlink{classRV}{RV} \&rv)}
34\label{classcompositepdf_08958c8f76d65de94ecc37b8d90bc77a}
35
36\begin{CompactList}\small\item\em fill all rv$\ast$inrv$\ast$ according to \item\end{CompactList}\item 
37\hypertarget{classcompositepdf_3bd4ada95f381ea6c4cff2dc86e957c4}{
38void \hyperlink{classcompositepdf_3bd4ada95f381ea6c4cff2dc86e957c4}{setrvcinrv} (const \hyperlink{classRV}{RV} \&rvc, Array$<$ ivec $>$ \&rvcind)}
39\label{classcompositepdf_3bd4ada95f381ea6c4cff2dc86e957c4}
40
41\begin{CompactList}\small\item\em Function fills Array by indeces of mpdfs inside given rv. \item\end{CompactList}\end{CompactItemize}
42\subsection*{Protected Attributes}
43\begin{CompactItemize}
44\item 
45\hypertarget{classcompositepdf_c1646fe41ff5934d010e54ccaa46133f}{
46int \hyperlink{classcompositepdf_c1646fe41ff5934d010e54ccaa46133f}{n}}
47\label{classcompositepdf_c1646fe41ff5934d010e54ccaa46133f}
48
49\begin{CompactList}\small\item\em Number of mpdfs in the composite. \item\end{CompactList}\item 
50\hypertarget{classcompositepdf_637877061b917a16a0421bb5c4cd480d}{
51Array$<$ \hyperlink{classmpdf}{mpdf} $\ast$ $>$ \hyperlink{classcompositepdf_637877061b917a16a0421bb5c4cd480d}{mpdfs}}
52\label{classcompositepdf_637877061b917a16a0421bb5c4cd480d}
53
54\begin{CompactList}\small\item\em Elements of composition. \item\end{CompactList}\item 
55\hypertarget{classcompositepdf_4d4a8269f9faefeca8cdc251a5a29a7f}{
56Array$<$ ivec $>$ \hyperlink{classcompositepdf_4d4a8269f9faefeca8cdc251a5a29a7f}{rvsinrv}}
57\label{classcompositepdf_4d4a8269f9faefeca8cdc251a5a29a7f}
58
59\begin{CompactList}\small\item\em Indeces of rvs in common rv. \item\end{CompactList}\item 
60\hypertarget{classcompositepdf_3df07bb5e3ed36a3119b145043296676}{
61Array$<$ ivec $>$ \hyperlink{classcompositepdf_3df07bb5e3ed36a3119b145043296676}{rvcsinrv}}
62\label{classcompositepdf_3df07bb5e3ed36a3119b145043296676}
63
64\begin{CompactList}\small\item\em Indeces of rvc in common rv. \item\end{CompactList}\item 
65\hypertarget{classcompositepdf_de3bd289a26d5549dcf1ed19e5b13569}{
66Array$<$ ivec $>$ \hyperlink{classcompositepdf_de3bd289a26d5549dcf1ed19e5b13569}{rvinrvcs}}
67\label{classcompositepdf_de3bd289a26d5549dcf1ed19e5b13569}
68
69\begin{CompactList}\small\item\em Indeces of common rv in rvc. \item\end{CompactList}\end{CompactItemize}
70
71
72\subsection{Detailed Description}
73Abstract composition of pdfs, a base for specific classes.
74
75\subsection{Member Function Documentation}
76\hypertarget{classcompositepdf_635d219fb3e32852400d6f98aa4bdc93}{
77\index{compositepdf@{compositepdf}!getrv@{getrv}}
78\index{getrv@{getrv}!compositepdf@{compositepdf}}
79\subsubsection[getrv]{\setlength{\rightskip}{0pt plus 5cm}{\bf RV} compositepdf::getrv (bool {\em checkoverlap} = {\tt false})}}
80\label{classcompositepdf_635d219fb3e32852400d6f98aa4bdc93}
81
82
83find common rv, flag
84
85\begin{Desc}
86\item[Parameters:]
87\begin{description}
88\item[{\em checkoverlap}]modifies whether overlaps are acceptable \end{description}
89\end{Desc}
90
91
92References RV::add(), mpdfs, and n.
93
94The documentation for this class was generated from the following files:\begin{CompactItemize}
95\item 
96work/git/mixpp/bdm/stat/\hyperlink{libBM_8h}{libBM.h}\item 
97work/git/mixpp/bdm/stat/libBM.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.