root/doc/latex/classbdm_1_1compositepdf.tex @ 275

Revision 271, 3.1 kB (checked in by smidl, 16 years ago)

Next major revision

Line 
1\hypertarget{classbdm_1_1compositepdf}{
2\section{bdm::compositepdf Class Reference}
3\label{classbdm_1_1compositepdf}\index{bdm::compositepdf@{bdm::compositepdf}}
4}
5{\tt \#include $<$libBM.h$>$}
6
7Inheritance diagram for bdm::compositepdf::\begin{figure}[H]
8\begin{center}
9\leavevmode
10\includegraphics[height=2cm]{classbdm_1_1compositepdf}
11\end{center}
12\end{figure}
13
14
15\subsection{Detailed Description}
16Abstract composition of pdfs, will be used for specific classes this abstract class is common to \hyperlink{classbdm_1_1epdf}{epdf} and \hyperlink{classbdm_1_1mpdf}{mpdf}. \subsection*{Public Member Functions}
17\begin{CompactItemize}
18\item 
19\hypertarget{classbdm_1_1compositepdf_b4fb137d679de83f037616697b172c5c}{
20\textbf{compositepdf} (Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ A0)}
21\label{classbdm_1_1compositepdf_b4fb137d679de83f037616697b172c5c}
22
23\item 
24\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}{getrv} (bool checkoverlap=false)
25\begin{CompactList}\small\item\em find common rv, flag \item\end{CompactList}\item 
26\hypertarget{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}{
27void \hyperlink{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}{setrvc} (const \hyperlink{classbdm_1_1RV}{RV} \&rv, \hyperlink{classbdm_1_1RV}{RV} \&rvc)}
28\label{classbdm_1_1compositepdf_c71fc2c51f49d797e61f479f543c75ce}
29
30\begin{CompactList}\small\item\em common rvc of all mpdfs is written to rvc \item\end{CompactList}\end{CompactItemize}
31\subsection*{Protected Attributes}
32\begin{CompactItemize}
33\item 
34\hypertarget{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}{
35int \hyperlink{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}{n}}
36\label{classbdm_1_1compositepdf_7ca3cd8ed92a7154f5b9ff13b1e9d52a}
37
38\begin{CompactList}\small\item\em Number of mpdfs in the composite. \item\end{CompactList}\item 
39\hypertarget{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}{
40Array$<$ \hyperlink{classbdm_1_1mpdf}{mpdf} $\ast$ $>$ \hyperlink{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}{mpdfs}}
41\label{classbdm_1_1compositepdf_23faf2debc4dde10836393b8c665914a}
42
43\begin{CompactList}\small\item\em Elements of composition. \item\end{CompactList}\end{CompactItemize}
44
45
46\subsection{Member Function Documentation}
47\hypertarget{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}{
48\index{bdm::compositepdf@{bdm::compositepdf}!getrv@{getrv}}
49\index{getrv@{getrv}!bdm::compositepdf@{bdm::compositepdf}}
50\subsubsection[getrv]{\setlength{\rightskip}{0pt plus 5cm}{\bf RV} bdm::compositepdf::getrv (bool {\em checkoverlap} = {\tt false})}}
51\label{classbdm_1_1compositepdf_c73d39acc4378eee6a63155c3517d3c9}
52
53
54find common rv, flag
55
56\begin{Desc}
57\item[Parameters:]
58\begin{description}
59\item[{\em checkoverlap}]modifies whether overlaps are acceptable \end{description}
60\end{Desc}
61
62
63References bdm::RV::add(), mpdfs, and n.
64
65Referenced by bdm::mprod::mprod().
66
67The documentation for this class was generated from the following files:\begin{CompactItemize}
68\item 
69\hyperlink{libBM_8h}{libBM.h}\item 
70libBM.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.