/[PAMELA software]/PamCut/doc/Doxygen/latex/classVerboseCollection.tex
ViewVC logotype

Contents of /PamCut/doc/Doxygen/latex/classVerboseCollection.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (show annotations) (download) (as text)
Fri Jun 5 13:15:20 2009 UTC (15 years, 10 months ago) by pam-fi
Branch: MAIN
Changes since 1.1: +4 -20 lines
File MIME type: application/x-tex
Updated.

1 \hypertarget{classVerboseCollection}{
2 \section{VerboseCollection Class Reference}
3 \label{classVerboseCollection}\index{VerboseCollection@{VerboseCollection}}
4 }
5 A smart collection which prints selection reports.
6
7
8 {\tt \#include $<$VerboseCollection.h$>$}
9
10 Inheritance diagram for VerboseCollection::\begin{figure}[H]
11 \begin{center}
12 \leavevmode
13 \includegraphics[height=4cm]{classVerboseCollection}
14 \end{center}
15 \end{figure}
16 \subsection*{Public Member Functions}
17 \begin{CompactItemize}
18 \item
19 \hyperlink{classVerboseCollection_00cc4b51c872adfea1abde1b84d4dd5f}{VerboseCollection} (const char $\ast$collectionName)
20 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 \hypertarget{classVerboseCollection_168e74f80f98b6fa43c5d4c1c1edb2e1}{
22 \hyperlink{classVerboseCollection_168e74f80f98b6fa43c5d4c1c1edb2e1}{$\sim$VerboseCollection} ()}
23 \label{classVerboseCollection_168e74f80f98b6fa43c5d4c1c1edb2e1}
24
25 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26 void \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{Finalize} ()
27 \begin{CompactList}\small\item\em The post analysis task. \item\end{CompactList}\end{CompactItemize}
28
29
30 \subsection{Detailed Description}
31 A smart collection which prints selection reports.
32
33 This class inherits from \hyperlink{classSmartCollection}{SmartCollection}, so it can handle actions. It is designed to automate a very common task: printing the selection results at the end of the analysis. Other desired tasks can be accomplished by means of actions.
34
35 \subsection{Constructor \& Destructor Documentation}
36 \hypertarget{classVerboseCollection_00cc4b51c872adfea1abde1b84d4dd5f}{
37 \index{VerboseCollection@{VerboseCollection}!VerboseCollection@{VerboseCollection}}
38 \index{VerboseCollection@{VerboseCollection}!VerboseCollection@{VerboseCollection}}
39 \subsubsection[{VerboseCollection}]{\setlength{\rightskip}{0pt plus 5cm}VerboseCollection::VerboseCollection (const char $\ast$ {\em collectionName})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
40 \label{classVerboseCollection_00cc4b51c872adfea1abde1b84d4dd5f}
41
42
43 Constructor.
44
45 \begin{Desc}
46 \item[Parameters:]
47 \begin{description}
48 \item[{\em collectionName}]The collection's name. \end{description}
49 \end{Desc}
50
51
52 \subsection{Member Function Documentation}
53 \hypertarget{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{
54 \index{VerboseCollection@{VerboseCollection}!Finalize@{Finalize}}
55 \index{Finalize@{Finalize}!VerboseCollection@{VerboseCollection}}
56 \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void VerboseCollection::Finalize ()\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
57 \label{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}
58
59
60 The post analysis task.
61
62 This implementation simply prints the selection report, and then calls SmartColletion::Finalize().
63
64 Reimplemented from \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection}.
65
66 The documentation for this class was generated from the following files:\begin{CompactItemize}
67 \item
68 Collections/VerboseCollection/\hyperlink{VerboseCollection_8h}{VerboseCollection.h}\item
69 Collections/VerboseCollection/\hyperlink{VerboseCollection_8cpp}{VerboseCollection.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23