root/doc/latex/classbdm_1_1compositepdf.tex @ 261

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

doc

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