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 |
|
|
\hyperlink{classPktQualCut_1129fbe226c512b9c6f8499968306faa}{PktQualCut} (const char $\ast$cutName) |
20 |
|
|
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item |
21 |
|
|
\hyperlink{classPktQualCut_f4937386b676871035dca05bb4e67889}{$\sim$PktQualCut} () |
22 |
|
|
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item |
23 |
|
|
int \hyperlink{classPktQualCut_80b1473a595cd2536ae434212bbe00fc}{Check} (PamLevel2 $\ast$event) |
24 |
|
|
\begin{CompactList}\small\item\em The packet number quality check. \item\end{CompactList}\end{CompactItemize} |
25 |
|
|
\subsection*{Private Attributes} |
26 |
|
|
\begin{CompactItemize} |
27 |
|
|
\item |
28 |
|
|
UInt\_\-t \hyperlink{classPktQualCut_3cfa4a53560dfd9c43e50dc08f3299e5}{\_\-previousPkt} |
29 |
|
|
\item |
30 |
|
|
UInt\_\-t \hyperlink{classPktQualCut_d6bae6178dbc8eb946f2d26de0049da8}{\_\-previousRun} |
31 |
|
|
\end{CompactItemize} |
32 |
|
|
|
33 |
|
|
|
34 |
|
|
\subsection{Detailed Description} |
35 |
|
|
The packet number quality cut. |
36 |
|
|
|
37 |
|
|
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. |
38 |
|
|
|
39 |
|
|
Definition at line 29 of file PktQualCut.h. |
40 |
|
|
|
41 |
|
|
\subsection{Constructor \& Destructor Documentation} |
42 |
|
|
\hypertarget{classPktQualCut_1129fbe226c512b9c6f8499968306faa}{ |
43 |
|
|
\index{PktQualCut@{PktQualCut}!PktQualCut@{PktQualCut}} |
44 |
|
|
\index{PktQualCut@{PktQualCut}!PktQualCut@{PktQualCut}} |
45 |
|
|
\subsubsection[{PktQualCut}]{\setlength{\rightskip}{0pt plus 5cm}PktQualCut::PktQualCut (const char $\ast$ {\em cutName})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
46 |
|
|
\label{classPktQualCut_1129fbe226c512b9c6f8499968306faa} |
47 |
|
|
|
48 |
|
|
|
49 |
|
|
Constructor. |
50 |
|
|
|
51 |
|
|
|
52 |
|
|
|
53 |
|
|
Definition at line 33 of file PktQualCut.h.\hypertarget{classPktQualCut_f4937386b676871035dca05bb4e67889}{ |
54 |
|
|
\index{PktQualCut@{PktQualCut}!$\sim$PktQualCut@{$\sim$PktQualCut}} |
55 |
|
|
\index{$\sim$PktQualCut@{$\sim$PktQualCut}!PktQualCut@{PktQualCut}} |
56 |
|
|
\subsubsection[{$\sim$PktQualCut}]{\setlength{\rightskip}{0pt plus 5cm}PktQualCut::$\sim$PktQualCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
57 |
|
|
\label{classPktQualCut_f4937386b676871035dca05bb4e67889} |
58 |
|
|
|
59 |
|
|
|
60 |
|
|
Destructor. |
61 |
|
|
|
62 |
|
|
|
63 |
|
|
|
64 |
|
|
Definition at line 37 of file PktQualCut.h. |
65 |
|
|
|
66 |
|
|
\subsection{Member Function Documentation} |
67 |
|
|
\hypertarget{classPktQualCut_80b1473a595cd2536ae434212bbe00fc}{ |
68 |
|
|
\index{PktQualCut@{PktQualCut}!Check@{Check}} |
69 |
|
|
\index{Check@{Check}!PktQualCut@{PktQualCut}} |
70 |
|
|
\subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int PktQualCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
71 |
|
|
\label{classPktQualCut_80b1473a595cd2536ae434212bbe00fc} |
72 |
|
|
|
73 |
|
|
|
74 |
|
|
The packet number quality check. |
75 |
|
|
|
76 |
|
|
\begin{Desc} |
77 |
|
|
\item[Parameters:] |
78 |
|
|
\begin{description} |
79 |
|
|
\item[{\em event}]The event to analyze. \end{description} |
80 |
|
|
\end{Desc} |
81 |
|
|
\begin{Desc} |
82 |
|
|
\item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if packet number $>$ previous packet number. |
83 |
|
|
|
84 |
|
|
\hyperlink{PktQualCut_8h_268e9cd01607bccd4ab9e6ec7532c738fac77ebed2c4fc251850c9a93f5196ad}{PKT\_\-NEWRUN} if the event has been discarded since it is the first of the run |
85 |
|
|
|
86 |
|
|
\hyperlink{PktQualCut_8h_268e9cd01607bccd4ab9e6ec7532c738361055874a7069d9fc9fa8acc562de02}{PKT\_\-INVALID} if packet number $>$ previous packet number. \end{Desc} |
87 |
|
|
|
88 |
|
|
|
89 |
|
|
Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}. |
90 |
|
|
|
91 |
|
|
Definition at line 12 of file PktQualCut.cpp. |
92 |
|
|
|
93 |
|
|
References \_\-previousPkt, \_\-previousRun, CUTOK, and PKT\_\-INVALID. |
94 |
|
|
|
95 |
|
|
\subsection{Member Data Documentation} |
96 |
|
|
\hypertarget{classPktQualCut_3cfa4a53560dfd9c43e50dc08f3299e5}{ |
97 |
|
|
\index{PktQualCut@{PktQualCut}!\_\-previousPkt@{\_\-previousPkt}} |
98 |
|
|
\index{\_\-previousPkt@{\_\-previousPkt}!PktQualCut@{PktQualCut}} |
99 |
|
|
\subsubsection[{\_\-previousPkt}]{\setlength{\rightskip}{0pt plus 5cm}UInt\_\-t {\bf PktQualCut::\_\-previousPkt}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
100 |
|
|
\label{classPktQualCut_3cfa4a53560dfd9c43e50dc08f3299e5} |
101 |
|
|
|
102 |
|
|
|
103 |
|
|
|
104 |
|
|
|
105 |
|
|
Definition at line 50 of file PktQualCut.h. |
106 |
|
|
|
107 |
|
|
Referenced by Check().\hypertarget{classPktQualCut_d6bae6178dbc8eb946f2d26de0049da8}{ |
108 |
|
|
\index{PktQualCut@{PktQualCut}!\_\-previousRun@{\_\-previousRun}} |
109 |
|
|
\index{\_\-previousRun@{\_\-previousRun}!PktQualCut@{PktQualCut}} |
110 |
|
|
\subsubsection[{\_\-previousRun}]{\setlength{\rightskip}{0pt plus 5cm}UInt\_\-t {\bf PktQualCut::\_\-previousRun}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
111 |
|
|
\label{classPktQualCut_d6bae6178dbc8eb946f2d26de0049da8} |
112 |
|
|
|
113 |
|
|
|
114 |
|
|
|
115 |
|
|
|
116 |
|
|
Definition at line 51 of file PktQualCut.h. |
117 |
|
|
|
118 |
|
|
Referenced by Check(). |
119 |
|
|
|
120 |
|
|
The documentation for this class was generated from the following files:\begin{CompactItemize} |
121 |
|
|
\item |
122 |
|
|
MiscCuts/PktQualCut/\hyperlink{PktQualCut_8h}{PktQualCut.h}\item |
123 |
|
|
MiscCuts/PktQualCut/\hyperlink{PktQualCut_8cpp}{PktQualCut.cpp}\end{CompactItemize} |