--- PamCut/doc/Doxygen/latex/classPamCutCollection.tex 2009/05/27 13:30:02 1.1.1.1 +++ PamCut/doc/Doxygen/latex/classPamCutCollection.tex 2009/09/25 15:44:20 1.3 @@ -18,7 +18,10 @@ \item \hyperlink{classPamCutCollection_756d6cc1c69e85a0f76e7674789c5588}{PamCutCollection} (const char $\ast$collectionName) \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item -\hyperlink{classPamCutCollection_932711c5f613639091adbcd851107b0c}{$\sim$PamCutCollection} () +\hypertarget{classPamCutCollection_932711c5f613639091adbcd851107b0c}{ +\hyperlink{classPamCutCollection_932711c5f613639091adbcd851107b0c}{$\sim$PamCutCollection} ()} +\label{classPamCutCollection_932711c5f613639091adbcd851107b0c} + \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item void \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut} (\hyperlink{classPamCut}{PamCut} \&cut) \begin{CompactList}\small\item\em Adds a cut to the cut collection This routine adds a cut to the collection. These are stored in a vector in the same order they are inserted (the first cut would be element 0, the second cut element 1 and so on). All the references to a \char`\"{}cut number\char`\"{} or \char`\"{}cut index\char`\"{} will refer to this numbering scheme. \item\end{CompactList}\item @@ -39,7 +42,10 @@ \subsection*{Protected Attributes} \begin{CompactItemize} \item -std::vector$<$ \hyperlink{classPamCut}{PamCut} $\ast$ $>$ \hyperlink{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}{\_\-cuts} +\hypertarget{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}{ +std::vector$<$ \hyperlink{classPamCut}{PamCut} $\ast$ $>$ \hyperlink{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}{\_\-cuts}} +\label{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403} + \begin{CompactList}\small\item\em A vector containing pointers to \hyperlink{classPamCut}{PamCut} objects. \item\end{CompactList}\end{CompactItemize} @@ -48,8 +54,6 @@ This is a multi-cut class, which inherits from \hyperlink{classPamCut}{PamCut}. Indeed, a multi-cut can be seen as a cut composed by various simpler cuts; hence the interface of \hyperlink{classPamCut}{PamCut} is also functional for \hyperlink{classPamCutCollection}{PamCutCollection}. The \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ApplyCut(PamLevel2 $\ast$event)} method is overridden so as all the cuts that compose the \hyperlink{classPamCutCollection}{PamCutCollection} are applied to the events in the same order they are added to the collection. Instead, \hyperlink{classPamCut_047b75499ea4457d60397ee5491adcd4}{Process(PamLevel2 $\ast$events, ULong\_\-t firstEvent, ULong\_\-t lastEvent)} is NOT overridden, since it performs the same task as the one in the base class: it is sufficient to override \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{Check(PamLevel2 $\ast$event)} to replace the single-cut evaluation with a multi-cut evaluation. -Definition at line 171 of file PamCutBase.h. - \subsection{Constructor \& Destructor Documentation} \hypertarget{classPamCutCollection_756d6cc1c69e85a0f76e7674789c5588}{ \index{PamCutCollection@{PamCutCollection}!PamCutCollection@{PamCutCollection}} @@ -67,19 +71,6 @@ \end{Desc} -Definition at line 178 of file PamCutBase.h.\hypertarget{classPamCutCollection_932711c5f613639091adbcd851107b0c}{ -\index{PamCutCollection@{PamCutCollection}!$\sim$PamCutCollection@{$\sim$PamCutCollection}} -\index{$\sim$PamCutCollection@{$\sim$PamCutCollection}!PamCutCollection@{PamCutCollection}} -\subsubsection[{$\sim$PamCutCollection}]{\setlength{\rightskip}{0pt plus 5cm}PamCutCollection::$\sim$PamCutCollection ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} -\label{classPamCutCollection_932711c5f613639091adbcd851107b0c} - - -Destructor. - - - -Definition at line 183 of file PamCutBase.h. - \subsection{Member Function Documentation} \hypertarget{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{ \index{PamCutCollection@{PamCutCollection}!AddCut@{AddCut}} @@ -95,11 +86,7 @@ \begin{description} \item[{\em cut}]The PamCut-derived object to add to the collection. \end{description} \end{Desc} - - -Definition at line 74 of file PamCutBase.cpp. - -References \_\-cuts.\hypertarget{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ +\hypertarget{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ \index{PamCutCollection@{PamCutCollection}!ApplyCut@{ApplyCut}} \index{ApplyCut@{ApplyCut}!PamCutCollection@{PamCutCollection}} \subsubsection[{ApplyCut}]{\setlength{\rightskip}{0pt plus 5cm}int PamCutCollection::ApplyCut (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} @@ -121,11 +108,7 @@ Reimplemented from \hyperlink{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{PamCut}. -Reimplemented in \hyperlink{classBlindCutCollection_8d387de8cbc54ff0eab8cff220b49c20}{BlindCutCollection}. - -Definition at line 94 of file PamCutBase.cpp. - -References \_\-cuts, PamCut::\_\-nEv, PamCut::\_\-nGood, CUTOK, PamCut::OnBad(), and PamCut::OnGood().\hypertarget{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{ +Reimplemented in \hyperlink{classBlindCutCollection_8d387de8cbc54ff0eab8cff220b49c20}{BlindCutCollection}, \hyperlink{classSmartBlindCollection_1eb231a8a437018bfd966644c7b18ba4}{SmartBlindCollection}, and \hyperlink{classSmartCollection_98213ec078e9b94ea70c72132757da46}{SmartCollection}.\hypertarget{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{ \index{PamCutCollection@{PamCutCollection}!Check@{Check}} \index{Check@{Check}!PamCutCollection@{PamCutCollection}} \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int PamCutCollection::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} @@ -137,16 +120,17 @@ Like in the mother class, this method performs a basic check on the current event: it calls \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{Check()} for each cut previously added with \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut()}, exiting if one of them is not satisfied. \begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em event}]The event to analyze. \end{description} +\end{Desc} +\begin{Desc} \item[Returns:]the index of the failed cut (range: \mbox{[}0, \#cuts-1\mbox{]}, see \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut()}); \hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the event satisfies all the cuts. \end{Desc} Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}. -Reimplemented in \hyperlink{classBlindCutCollection_016ee86612e57a50f03c8469d3ed9d1f}{BlindCutCollection}. - -Definition at line 78 of file PamCutBase.cpp. - -References \_\-cuts, and CUTOK.\hypertarget{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{ +Reimplemented in \hyperlink{classBlindCutCollection_016ee86612e57a50f03c8469d3ed9d1f}{BlindCutCollection}.\hypertarget{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{ \index{PamCutCollection@{PamCutCollection}!Finalize@{Finalize}} \index{Finalize@{Finalize}!PamCutCollection@{PamCutCollection}} \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void PamCutCollection::Finalize ()\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} @@ -159,11 +143,7 @@ Reimplemented from \hyperlink{classPamCut_fd74c1565552cabe4aced316df803737}{PamCut}. -Reimplemented in \hyperlink{classSmartBlindCollection_a78ee7b18b0913554e64b4e560453167}{SmartBlindCollection}, \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection}, \hyperlink{classVerboseBlindCollection_43d6ea7b5ea35c5dbb342e23584b79ee}{VerboseBlindCollection}, and \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}. - -Definition at line 146 of file PamCutBase.cpp. - -References \_\-cuts, and GetSize().\hypertarget{classPamCutCollection_55e41082749260f5cee2fd53d9fd331b}{ +Reimplemented in \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection}, \hyperlink{classVerboseBlindCollection_43d6ea7b5ea35c5dbb342e23584b79ee}{VerboseBlindCollection}, and \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}.\hypertarget{classPamCutCollection_55e41082749260f5cee2fd53d9fd331b}{ \index{PamCutCollection@{PamCutCollection}!GetCut@{GetCut}} \index{GetCut@{GetCut}!PamCutCollection@{PamCutCollection}} \subsubsection[{GetCut}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PamCut} $\ast$ PamCutCollection::GetCut (unsigned int {\em iCut})}} @@ -181,13 +161,7 @@ \end{Desc} \begin{Desc} \item[Returns:]pointer to the iCut-th cut; NULL if the specified cut cannot be found or if no cuts are present. \end{Desc} - - -Definition at line 116 of file PamCutBase.cpp. - -References \_\-cuts. - -Referenced by VerboseCollection::Finalize(), and VerboseBlindCollection::Finalize().\hypertarget{classPamCutCollection_231f91b82b18cf326a2912b0b515baca}{ +\hypertarget{classPamCutCollection_231f91b82b18cf326a2912b0b515baca}{ \index{PamCutCollection@{PamCutCollection}!GetSize@{GetSize}} \index{GetSize@{GetSize}!PamCutCollection@{PamCutCollection}} \subsubsection[{GetSize}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int PamCutCollection::GetSize ()}} @@ -198,13 +172,7 @@ \begin{Desc} \item[Returns:]The number of cuts \end{Desc} - - -Definition at line 125 of file PamCutBase.cpp. - -References \_\-cuts. - -Referenced by Finalize(), VerboseCollection::Finalize(), VerboseBlindCollection::Finalize(), and Setup().\hypertarget{classPamCutCollection_3fb36e5fb38627f5cbffe6c23cf57d2a}{ +\hypertarget{classPamCutCollection_3fb36e5fb38627f5cbffe6c23cf57d2a}{ \index{PamCutCollection@{PamCutCollection}!operator=@{operator=}} \index{operator=@{operator=}!PamCutCollection@{PamCutCollection}} \subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PamCutCollection} \& PamCutCollection::operator= (const {\bf PamCutCollection} \& {\em rightValue})}} @@ -220,11 +188,7 @@ \end{Desc} \begin{Desc} \item[Returns:]The new value for LHS. \end{Desc} - - -Definition at line 130 of file PamCutBase.cpp. - -References \_\-cuts.\hypertarget{classPamCutCollection_982821389af5e585688611d733b3a7b0}{ +\hypertarget{classPamCutCollection_982821389af5e585688611d733b3a7b0}{ \index{PamCutCollection@{PamCutCollection}!Setup@{Setup}} \index{Setup@{Setup}!PamCutCollection@{PamCutCollection}} \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void PamCutCollection::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} @@ -244,27 +208,7 @@ Reimplemented from \hyperlink{classPamCut_e587828903b809c99f9ab5ba97ae6616}{PamCut}. -Reimplemented in \hyperlink{classSmartBlindCollection_e59d373921df00a54a8a8401a1ae2baf}{SmartBlindCollection}, and \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{SmartCollection}. - -Definition at line 137 of file PamCutBase.cpp. - -References \_\-cuts, and GetSize(). - -\subsection{Member Data Documentation} -\hypertarget{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}{ -\index{PamCutCollection@{PamCutCollection}!\_\-cuts@{\_\-cuts}} -\index{\_\-cuts@{\_\-cuts}!PamCutCollection@{PamCutCollection}} -\subsubsection[{\_\-cuts}]{\setlength{\rightskip}{0pt plus 5cm}std::vector$<${\bf PamCut}$\ast$$>$ {\bf PamCutCollection::\_\-cuts}\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}} -\label{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403} - - -A vector containing pointers to \hyperlink{classPamCut}{PamCut} objects. - - - -Definition at line 261 of file PamCutBase.h. - -Referenced by AddCut(), ApplyCut(), BlindCutCollection::ApplyCut(), Check(), BlindCutCollection::Check(), Finalize(), VerboseCollection::Finalize(), VerboseBlindCollection::Finalize(), GetCut(), GetSize(), operator=(), and Setup(). +Reimplemented in \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{SmartCollection}. The documentation for this class was generated from the following files:\begin{CompactItemize} \item