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

Annotation of /PamCut/doc/Doxygen/latex/classPktQualCut.tex

Parent Directory Parent Directory | Revision Log Revision Log


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

1 pam-fi 1.1 \hypertarget{classPktQualCut}{
2     \section{PktQualCut Class Reference}
3     \label{classPktQualCut}\index{PktQualCut@{PktQualCut}}
4     }
5     The packet number quality cut.
6    
7    
8     {\tt \#include $<$PktQualCut.h$>$}
9    
10     Inheritance diagram for PktQualCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classPktQualCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19 pam-fi 1.2 \hypertarget{classPktQualCut_1129fbe226c512b9c6f8499968306faa}{
20     \hyperlink{classPktQualCut_1129fbe226c512b9c6f8499968306faa}{PktQualCut} (const char $\ast$cutName)}
21     \label{classPktQualCut_1129fbe226c512b9c6f8499968306faa}
22    
23 pam-fi 1.1 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
24 pam-fi 1.2 \hypertarget{classPktQualCut_f4937386b676871035dca05bb4e67889}{
25     \hyperlink{classPktQualCut_f4937386b676871035dca05bb4e67889}{$\sim$PktQualCut} ()}
26     \label{classPktQualCut_f4937386b676871035dca05bb4e67889}
27    
28 pam-fi 1.1 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
29     int \hyperlink{classPktQualCut_80b1473a595cd2536ae434212bbe00fc}{Check} (PamLevel2 $\ast$event)
30     \begin{CompactList}\small\item\em The packet number quality check. \item\end{CompactList}\end{CompactItemize}
31    
32    
33     \subsection{Detailed Description}
34     The packet number quality cut.
35    
36     This cut rejects events whose packet number is less than that of the previous event. When a new run starts, the previous packet number is set to the current one and the current event (ie., the first event of the run) is discarded.
37    
38     \subsection{Member Function Documentation}
39     \hypertarget{classPktQualCut_80b1473a595cd2536ae434212bbe00fc}{
40     \index{PktQualCut@{PktQualCut}!Check@{Check}}
41     \index{Check@{Check}!PktQualCut@{PktQualCut}}
42     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int PktQualCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
43     \label{classPktQualCut_80b1473a595cd2536ae434212bbe00fc}
44    
45    
46     The packet number quality check.
47    
48     \begin{Desc}
49     \item[Parameters:]
50     \begin{description}
51     \item[{\em event}]The event to analyze. \end{description}
52     \end{Desc}
53     \begin{Desc}
54     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if packet number $>$ previous packet number.
55    
56     \hyperlink{PktQualCut_8h_268e9cd01607bccd4ab9e6ec7532c738fac77ebed2c4fc251850c9a93f5196ad}{PKT\_\-NEWRUN} if the event has been discarded since it is the first of the run
57    
58     \hyperlink{PktQualCut_8h_268e9cd01607bccd4ab9e6ec7532c738361055874a7069d9fc9fa8acc562de02}{PKT\_\-INVALID} if packet number $>$ previous packet number. \end{Desc}
59    
60    
61     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
62    
63     The documentation for this class was generated from the following files:\begin{CompactItemize}
64     \item
65     MiscCuts/PktQualCut/\hyperlink{PktQualCut_8h}{PktQualCut.h}\item
66     MiscCuts/PktQualCut/\hyperlink{PktQualCut_8cpp}{PktQualCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23