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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

1 \hypertarget{classAbsTimeCut}{
2 \section{AbsTimeCut Class Reference}
3 \label{classAbsTimeCut}\index{AbsTimeCut@{AbsTimeCut}}
4 }
5 A cut on absolute time.
6
7
8 {\tt \#include $<$AbsTimeCut.h$>$}
9
10 Inheritance diagram for AbsTimeCut::\begin{figure}[H]
11 \begin{center}
12 \leavevmode
13 \includegraphics[height=2cm]{classAbsTimeCut}
14 \end{center}
15 \end{figure}
16 \subsection*{Public Member Functions}
17 \begin{CompactItemize}
18 \item
19 \hyperlink{classAbsTimeCut_3a10b984df8c49274bbad0e794c26aa0}{AbsTimeCut} (const char $\ast$cutName, const char $\ast$initDate, const char $\ast$initTime, const char $\ast$endDate, const char $\ast$endTime)
20 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 \hypertarget{classAbsTimeCut_06347d939b41bc6bb87cf6d705bef817}{
22 \hyperlink{classAbsTimeCut_06347d939b41bc6bb87cf6d705bef817}{$\sim$AbsTimeCut} ()}
23 \label{classAbsTimeCut_06347d939b41bc6bb87cf6d705bef817}
24
25 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26 int \hyperlink{classAbsTimeCut_f7c55e8b9e801a59ea93f9b5b9212c8c}{Check} (PamLevel2 $\ast$event)
27 \begin{CompactList}\small\item\em The absolute time check. \item\end{CompactList}\end{CompactItemize}
28
29
30 \subsection{Detailed Description}
31 A cut on absolute time.
32
33 This selection rejects all events recorded outside a certain time interval.
34
35 \subsection{Constructor \& Destructor Documentation}
36 \hypertarget{classAbsTimeCut_3a10b984df8c49274bbad0e794c26aa0}{
37 \index{AbsTimeCut@{AbsTimeCut}!AbsTimeCut@{AbsTimeCut}}
38 \index{AbsTimeCut@{AbsTimeCut}!AbsTimeCut@{AbsTimeCut}}
39 \subsubsection[{AbsTimeCut}]{\setlength{\rightskip}{0pt plus 5cm}AbsTimeCut::AbsTimeCut (const char $\ast$ {\em cutName}, \/ const char $\ast$ {\em initDate}, \/ const char $\ast$ {\em initTime}, \/ const char $\ast$ {\em endDate}, \/ const char $\ast$ {\em endTime})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
40 \label{classAbsTimeCut_3a10b984df8c49274bbad0e794c26aa0}
41
42
43 Constructor.
44
45 The parameters define the time interval. They have to be encoded as 6-digits numbers, eg.: 18 March 2008 15:30:00 will be encoded as 080318 for the date and as 153000 for the time.
46
47 \begin{Desc}
48 \item[Parameters:]
49 \begin{description}
50 \item[{\em cutName}]The cut's name \item[{\em initDate}]The initial date (format: YYMMDD). \item[{\em initTime}]The initial time (format: hhmmss). \item[{\em endDate}]The final date (format: YYMMDD);. \item[{\em endTime}]The final time (format: hhmmss). \end{description}
51 \end{Desc}
52
53
54 \subsection{Member Function Documentation}
55 \hypertarget{classAbsTimeCut_f7c55e8b9e801a59ea93f9b5b9212c8c}{
56 \index{AbsTimeCut@{AbsTimeCut}!Check@{Check}}
57 \index{Check@{Check}!AbsTimeCut@{AbsTimeCut}}
58 \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int AbsTimeCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
59 \label{classAbsTimeCut_f7c55e8b9e801a59ea93f9b5b9212c8c}
60
61
62 The absolute time check.
63
64 \begin{Desc}
65 \item[Parameters:]
66 \begin{description}
67 \item[{\em event}]The event to analyze. \end{description}
68 \end{Desc}
69 \begin{Desc}
70 \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the event happened inside the time interval
71
72 \hyperlink{AbsTimeCut_8h_838416b232e35f3a8e213039a37617a2c254e386daee724374f521ee95e31678}{ABSTIMECUT\_\-TOOEARLY} if the event happened before the begin of the time interval.
73
74 \hyperlink{AbsTimeCut_8h_838416b232e35f3a8e213039a37617a2822616ea1321765802ee3e367b0f8be1}{ABSTIMECUT\_\-TOOLATE} if the event happened after the end of the time interval. \end{Desc}
75
76
77 Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
78
79 The documentation for this class was generated from the following files:\begin{CompactItemize}
80 \item
81 MiscCuts/AbsTimeCut/\hyperlink{AbsTimeCut_8h}{AbsTimeCut.h}\item
82 MiscCuts/AbsTimeCut/\hyperlink{AbsTimeCut_8cpp}{AbsTimeCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23