| 1 |
pam-fi |
1.1 |
\hypertarget{classSmartCollection}{ |
| 2 |
|
|
\section{SmartCollection Class Reference} |
| 3 |
|
|
\label{classSmartCollection}\index{SmartCollection@{SmartCollection}} |
| 4 |
|
|
} |
| 5 |
|
|
A collection class designed to use \hyperlink{classCollectionAction}{CollectionAction} objects. |
| 6 |
|
|
|
| 7 |
|
|
|
| 8 |
|
|
{\tt \#include $<$SmartCollection.h$>$} |
| 9 |
|
|
|
| 10 |
|
|
Inheritance diagram for SmartCollection::\begin{figure}[H] |
| 11 |
|
|
\begin{center} |
| 12 |
|
|
\leavevmode |
| 13 |
|
|
\includegraphics[height=4cm]{classSmartCollection} |
| 14 |
|
|
\end{center} |
| 15 |
|
|
\end{figure} |
| 16 |
|
|
\subsection*{Public Member Functions} |
| 17 |
|
|
\begin{CompactItemize} |
| 18 |
|
|
\item |
| 19 |
|
|
\hyperlink{classSmartCollection_597157bb186c4688cd305b62a197009d}{SmartCollection} (const char $\ast$collectionName) |
| 20 |
|
|
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item |
| 21 |
|
|
\hyperlink{classSmartCollection_63fdadd219eb42065c6e9adc63558b63}{$\sim$SmartCollection} () |
| 22 |
|
|
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item |
| 23 |
|
|
virtual void \hyperlink{classSmartCollection_9265adb168bca295f264af65276a002b}{AddAction} (\hyperlink{classCollectionAction}{CollectionAction} \&action) |
| 24 |
|
|
\begin{CompactList}\small\item\em Adds an action to the \hyperlink{classSmartCollection}{SmartCollection}. \item\end{CompactList}\item |
| 25 |
|
|
\hyperlink{classCollectionAction}{CollectionAction} $\ast$ \hyperlink{classSmartCollection_acadaf64f683e7932c376e924e7020ea}{GetAction} (unsigned int iAction) |
| 26 |
|
|
\begin{CompactList}\small\item\em Returns the iAction-th action. \item\end{CompactList}\item |
| 27 |
|
|
void \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{Setup} (PamLevel2 $\ast$events) |
| 28 |
|
|
\begin{CompactList}\small\item\em The pre-analysis task definition. \item\end{CompactList}\item |
| 29 |
|
|
void \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{Finalize} () |
| 30 |
|
|
\begin{CompactList}\small\item\em The post-analysis task definition. \item\end{CompactList}\item |
| 31 |
|
|
void \hyperlink{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}{OnGood} (PamLevel2 $\ast$event) |
| 32 |
|
|
\begin{CompactList}\small\item\em Post-selection tasks. \item\end{CompactList}\item |
| 33 |
|
|
void \hyperlink{classSmartCollection_99ac049c98461fbe04167f386ca7ed76}{OnBad} (PamLevel2 $\ast$event, int selectionResult) |
| 34 |
|
|
\begin{CompactList}\small\item\em Post-selection tasks. \item\end{CompactList}\end{CompactItemize} |
| 35 |
|
|
\subsection*{Private Attributes} |
| 36 |
|
|
\begin{CompactItemize} |
| 37 |
|
|
\item |
| 38 |
|
|
std::vector$<$ \hyperlink{classCollectionAction}{CollectionAction} $\ast$ $>$ \hyperlink{classSmartCollection_a80a9cf5cab3683a61b47a1145ff8f15}{\_\-actions} |
| 39 |
|
|
\end{CompactItemize} |
| 40 |
|
|
|
| 41 |
|
|
|
| 42 |
|
|
\subsection{Detailed Description} |
| 43 |
|
|
A collection class designed to use \hyperlink{classCollectionAction}{CollectionAction} objects. |
| 44 |
|
|
|
| 45 |
|
|
The \hyperlink{classSmartCollection}{SmartCollection} class is designed to handle \hyperlink{classCollectionAction}{CollectionAction} objects. These defines the procedures to do when an event is selected or discarded. A \hyperlink{classSmartCollection}{SmartCollection} handles a vector of these objects, calling \hyperlink{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{CollectionAction::OnGood()} for each of them when a good event is selected and \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{CollectionAction::OnBad()} when a bad one is rejected. It will also call the \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{CollectionAction::Setup()} and \hyperlink{classCollectionAction_c32b42fc08bc1be7b003579b633de041}{CollectionAction::Finalize()} methods at the beginning and at the end of the analysis, respectively. |
| 46 |
|
|
|
| 47 |
|
|
Definition at line 26 of file SmartCollection.h. |
| 48 |
|
|
|
| 49 |
|
|
\subsection{Constructor \& Destructor Documentation} |
| 50 |
|
|
\hypertarget{classSmartCollection_597157bb186c4688cd305b62a197009d}{ |
| 51 |
|
|
\index{SmartCollection@{SmartCollection}!SmartCollection@{SmartCollection}} |
| 52 |
|
|
\index{SmartCollection@{SmartCollection}!SmartCollection@{SmartCollection}} |
| 53 |
|
|
\subsubsection[{SmartCollection}]{\setlength{\rightskip}{0pt plus 5cm}SmartCollection::SmartCollection (const char $\ast$ {\em collectionName})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 54 |
|
|
\label{classSmartCollection_597157bb186c4688cd305b62a197009d} |
| 55 |
|
|
|
| 56 |
|
|
|
| 57 |
|
|
Constructor. |
| 58 |
|
|
|
| 59 |
|
|
\begin{Desc} |
| 60 |
|
|
\item[Parameters:] |
| 61 |
|
|
\begin{description} |
| 62 |
|
|
\item[{\em collectionName}]The collection's name. \end{description} |
| 63 |
|
|
\end{Desc} |
| 64 |
|
|
|
| 65 |
|
|
|
| 66 |
|
|
Definition at line 34 of file SmartCollection.h.\hypertarget{classSmartCollection_63fdadd219eb42065c6e9adc63558b63}{ |
| 67 |
|
|
\index{SmartCollection@{SmartCollection}!$\sim$SmartCollection@{$\sim$SmartCollection}} |
| 68 |
|
|
\index{$\sim$SmartCollection@{$\sim$SmartCollection}!SmartCollection@{SmartCollection}} |
| 69 |
|
|
\subsubsection[{$\sim$SmartCollection}]{\setlength{\rightskip}{0pt plus 5cm}SmartCollection::$\sim$SmartCollection ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 70 |
|
|
\label{classSmartCollection_63fdadd219eb42065c6e9adc63558b63} |
| 71 |
|
|
|
| 72 |
|
|
|
| 73 |
|
|
Destructor. |
| 74 |
|
|
|
| 75 |
|
|
|
| 76 |
|
|
|
| 77 |
|
|
Definition at line 39 of file SmartCollection.h. |
| 78 |
|
|
|
| 79 |
|
|
\subsection{Member Function Documentation} |
| 80 |
|
|
\hypertarget{classSmartCollection_9265adb168bca295f264af65276a002b}{ |
| 81 |
|
|
\index{SmartCollection@{SmartCollection}!AddAction@{AddAction}} |
| 82 |
|
|
\index{AddAction@{AddAction}!SmartCollection@{SmartCollection}} |
| 83 |
|
|
\subsubsection[{AddAction}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::AddAction ({\bf CollectionAction} \& {\em action})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 84 |
|
|
\label{classSmartCollection_9265adb168bca295f264af65276a002b} |
| 85 |
|
|
|
| 86 |
|
|
|
| 87 |
|
|
Adds an action to the \hyperlink{classSmartCollection}{SmartCollection}. |
| 88 |
|
|
|
| 89 |
|
|
|
| 90 |
|
|
|
| 91 |
|
|
Definition at line 12 of file SmartCollection.cpp. |
| 92 |
|
|
|
| 93 |
|
|
References \_\-actions.\hypertarget{classSmartCollection_8105730615ad127a482a7fb399695977}{ |
| 94 |
|
|
\index{SmartCollection@{SmartCollection}!Finalize@{Finalize}} |
| 95 |
|
|
\index{Finalize@{Finalize}!SmartCollection@{SmartCollection}} |
| 96 |
|
|
\subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::Finalize ()\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 97 |
|
|
\label{classSmartCollection_8105730615ad127a482a7fb399695977} |
| 98 |
|
|
|
| 99 |
|
|
|
| 100 |
|
|
The post-analysis task definition. |
| 101 |
|
|
|
| 102 |
|
|
This override of the \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{Finalize()} method calls \hyperlink{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{PamCutCollection::Finalize()} and then the \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{Finalize()} method of each action contained in the \hyperlink{classSmartCollection}{SmartCollection}. |
| 103 |
|
|
|
| 104 |
|
|
Reimplemented from \hyperlink{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{PamCutCollection}. |
| 105 |
|
|
|
| 106 |
|
|
Reimplemented in \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}. |
| 107 |
|
|
|
| 108 |
|
|
Definition at line 33 of file SmartCollection.cpp. |
| 109 |
|
|
|
| 110 |
|
|
References \_\-actions.\hypertarget{classSmartCollection_acadaf64f683e7932c376e924e7020ea}{ |
| 111 |
|
|
\index{SmartCollection@{SmartCollection}!GetAction@{GetAction}} |
| 112 |
|
|
\index{GetAction@{GetAction}!SmartCollection@{SmartCollection}} |
| 113 |
|
|
\subsubsection[{GetAction}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CollectionAction} $\ast$ SmartCollection::GetAction (unsigned int {\em iAction})}} |
| 114 |
|
|
\label{classSmartCollection_acadaf64f683e7932c376e924e7020ea} |
| 115 |
|
|
|
| 116 |
|
|
|
| 117 |
|
|
Returns the iAction-th action. |
| 118 |
|
|
|
| 119 |
|
|
\begin{Desc} |
| 120 |
|
|
\item[Parameters:] |
| 121 |
|
|
\begin{description} |
| 122 |
|
|
\item[{\em iAction}]The index of the desired \hyperlink{classCollectionAction}{CollectionAction}, defined as the insertion order (from 0 to \#actions-1, see \hyperlink{classSmartCollection_9265adb168bca295f264af65276a002b}{AddAction()}). \end{description} |
| 123 |
|
|
\end{Desc} |
| 124 |
|
|
\begin{Desc} |
| 125 |
|
|
\item[Returns:]pointer to the iAction-th action; NULL if the specified action cannot be found or if no actions are present. \end{Desc} |
| 126 |
|
|
|
| 127 |
|
|
|
| 128 |
|
|
Definition at line 16 of file SmartCollection.cpp. |
| 129 |
|
|
|
| 130 |
|
|
References \_\-actions.\hypertarget{classSmartCollection_99ac049c98461fbe04167f386ca7ed76}{ |
| 131 |
|
|
\index{SmartCollection@{SmartCollection}!OnBad@{OnBad}} |
| 132 |
|
|
\index{OnBad@{OnBad}!SmartCollection@{SmartCollection}} |
| 133 |
|
|
\subsubsection[{OnBad}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::OnBad (PamLevel2 $\ast$ {\em event}, \/ int {\em selectionResult})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 134 |
|
|
\label{classSmartCollection_99ac049c98461fbe04167f386ca7ed76} |
| 135 |
|
|
|
| 136 |
|
|
|
| 137 |
|
|
Post-selection tasks. |
| 138 |
|
|
|
| 139 |
|
|
This routine is automatically called after a bad event has been rejected by \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ApplyCut()}. It will simply call \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{PamCutCollection::OnBad()} and then \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{CollectionAction::OnBad()} for each action in the \hyperlink{classSmartCollection}{SmartCollection}. |
| 140 |
|
|
|
| 141 |
|
|
\begin{Desc} |
| 142 |
|
|
\item[See also:]\hyperlink{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}{OnGood} \end{Desc} |
| 143 |
|
|
\begin{Desc} |
| 144 |
|
|
\item[Parameters:] |
| 145 |
|
|
\begin{description} |
| 146 |
|
|
\item[{\em event}]The event which don't satisfy the cut. \item[{\em selectionResult}]The return value of the \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{Check()} routine. \end{description} |
| 147 |
|
|
\end{Desc} |
| 148 |
|
|
|
| 149 |
|
|
|
| 150 |
|
|
Reimplemented from \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{PamCut}. |
| 151 |
|
|
|
| 152 |
|
|
Definition at line 49 of file SmartCollection.cpp. |
| 153 |
|
|
|
| 154 |
|
|
References \_\-actions.\hypertarget{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}{ |
| 155 |
|
|
\index{SmartCollection@{SmartCollection}!OnGood@{OnGood}} |
| 156 |
|
|
\index{OnGood@{OnGood}!SmartCollection@{SmartCollection}} |
| 157 |
|
|
\subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 158 |
|
|
\label{classSmartCollection_13ce6deb47b60d10225598dd1201cd80} |
| 159 |
|
|
|
| 160 |
|
|
|
| 161 |
|
|
Post-selection tasks. |
| 162 |
|
|
|
| 163 |
|
|
This routine is automatically called after a good event has been selected by \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ApplyCut()}. It will simply call \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{PamCutCollection::OnGood()} and then \hyperlink{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{CollectionAction::OnGood()} for each action in the \hyperlink{classSmartCollection}{SmartCollection}. \begin{Desc} |
| 164 |
|
|
\item[Parameters:] |
| 165 |
|
|
\begin{description} |
| 166 |
|
|
\item[{\em event}]The event which satisfy the cut. \end{description} |
| 167 |
|
|
\end{Desc} |
| 168 |
|
|
|
| 169 |
|
|
|
| 170 |
|
|
Reimplemented from \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{PamCut}. |
| 171 |
|
|
|
| 172 |
|
|
Definition at line 41 of file SmartCollection.cpp. |
| 173 |
|
|
|
| 174 |
|
|
References \_\-actions.\hypertarget{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{ |
| 175 |
|
|
\index{SmartCollection@{SmartCollection}!Setup@{Setup}} |
| 176 |
|
|
\index{Setup@{Setup}!SmartCollection@{SmartCollection}} |
| 177 |
|
|
\subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 178 |
|
|
\label{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c} |
| 179 |
|
|
|
| 180 |
|
|
|
| 181 |
|
|
The pre-analysis task definition. |
| 182 |
|
|
|
| 183 |
|
|
This override of the \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{Setup()} method calls \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{Setup()} for the base class \hyperlink{classPamCutCollection}{PamCutCollection}, and subsequently for each action contained in the \hyperlink{classSmartCollection}{SmartCollection}. |
| 184 |
|
|
|
| 185 |
|
|
\begin{Desc} |
| 186 |
|
|
\item[Parameters:] |
| 187 |
|
|
\begin{description} |
| 188 |
|
|
\item[{\em events}]The PamLevel2 pointer to the events that will be analyzed. Used only as parameter for \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{CollectionAction::Setup()}. \end{description} |
| 189 |
|
|
\end{Desc} |
| 190 |
|
|
|
| 191 |
|
|
|
| 192 |
|
|
Reimplemented from \hyperlink{classPamCutCollection_982821389af5e585688611d733b3a7b0}{PamCutCollection}. |
| 193 |
|
|
|
| 194 |
|
|
Definition at line 25 of file SmartCollection.cpp. |
| 195 |
|
|
|
| 196 |
|
|
References \_\-actions. |
| 197 |
|
|
|
| 198 |
|
|
\subsection{Member Data Documentation} |
| 199 |
|
|
\hypertarget{classSmartCollection_a80a9cf5cab3683a61b47a1145ff8f15}{ |
| 200 |
|
|
\index{SmartCollection@{SmartCollection}!\_\-actions@{\_\-actions}} |
| 201 |
|
|
\index{\_\-actions@{\_\-actions}!SmartCollection@{SmartCollection}} |
| 202 |
|
|
\subsubsection[{\_\-actions}]{\setlength{\rightskip}{0pt plus 5cm}std::vector$<${\bf CollectionAction}$\ast$$>$ {\bf SmartCollection::\_\-actions}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
| 203 |
|
|
\label{classSmartCollection_a80a9cf5cab3683a61b47a1145ff8f15} |
| 204 |
|
|
|
| 205 |
|
|
|
| 206 |
|
|
|
| 207 |
|
|
|
| 208 |
|
|
Definition at line 93 of file SmartCollection.h. |
| 209 |
|
|
|
| 210 |
|
|
Referenced by AddAction(), Finalize(), GetAction(), OnBad(), OnGood(), and Setup(). |
| 211 |
|
|
|
| 212 |
|
|
The documentation for this class was generated from the following files:\begin{CompactItemize} |
| 213 |
|
|
\item |
| 214 |
|
|
Collections/SmartCollection/\hyperlink{SmartCollection_8h}{SmartCollection.h}\item |
| 215 |
|
|
Collections/SmartCollection/\hyperlink{SmartCollection_8cpp}{SmartCollection.cpp}\end{CompactItemize} |
Parent Directory
| 
Revision Log