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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:03 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: MAIN
Branch point for: DEV
File MIME type: application/x-tex
Initial revision

1 pam-fi 1.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     \hyperlink{classAbsTimeCut_06347d939b41bc6bb87cf6d705bef817}{$\sim$AbsTimeCut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classAbsTimeCut_f7c55e8b9e801a59ea93f9b5b9212c8c}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em The absolute time check. \item\end{CompactList}\end{CompactItemize}
25     \subsection*{Private Attributes}
26     \begin{CompactItemize}
27     \item
28     unsigned int \hyperlink{classAbsTimeCut_2637d0d2979325a03ac34ee3d594e443}{\_\-initDate}
29     \item
30     unsigned int \hyperlink{classAbsTimeCut_7c329ea08fb7381a62a967275433fc0d}{\_\-initTime}
31     \item
32     unsigned int \hyperlink{classAbsTimeCut_5b7824fb8b1bd398939a0abe497dcd81}{\_\-endDate}
33     \item
34     unsigned int \hyperlink{classAbsTimeCut_9395725348a6e6805c8b224f6efdf039}{\_\-endTime}
35     \item
36     TTimeStamp \hyperlink{classAbsTimeCut_1568851623e9d725a527e2a4276ca34a}{\_\-time}
37     \end{CompactItemize}
38    
39    
40     \subsection{Detailed Description}
41     A cut on absolute time.
42    
43     This selection rejects all events recorded outside a certain time interval.
44    
45     Definition at line 27 of file AbsTimeCut.h.
46    
47     \subsection{Constructor \& Destructor Documentation}
48     \hypertarget{classAbsTimeCut_3a10b984df8c49274bbad0e794c26aa0}{
49     \index{AbsTimeCut@{AbsTimeCut}!AbsTimeCut@{AbsTimeCut}}
50     \index{AbsTimeCut@{AbsTimeCut}!AbsTimeCut@{AbsTimeCut}}
51     \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{]}}}}
52     \label{classAbsTimeCut_3a10b984df8c49274bbad0e794c26aa0}
53    
54    
55     Constructor.
56    
57     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.
58    
59     \begin{Desc}
60     \item[Parameters:]
61     \begin{description}
62     \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}
63     \end{Desc}
64    
65    
66     Definition at line 42 of file AbsTimeCut.h.\hypertarget{classAbsTimeCut_06347d939b41bc6bb87cf6d705bef817}{
67     \index{AbsTimeCut@{AbsTimeCut}!$\sim$AbsTimeCut@{$\sim$AbsTimeCut}}
68     \index{$\sim$AbsTimeCut@{$\sim$AbsTimeCut}!AbsTimeCut@{AbsTimeCut}}
69     \subsubsection[{$\sim$AbsTimeCut}]{\setlength{\rightskip}{0pt plus 5cm}AbsTimeCut::$\sim$AbsTimeCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
70     \label{classAbsTimeCut_06347d939b41bc6bb87cf6d705bef817}
71    
72    
73     Destructor.
74    
75    
76    
77     Definition at line 49 of file AbsTimeCut.h.
78    
79     \subsection{Member Function Documentation}
80     \hypertarget{classAbsTimeCut_f7c55e8b9e801a59ea93f9b5b9212c8c}{
81     \index{AbsTimeCut@{AbsTimeCut}!Check@{Check}}
82     \index{Check@{Check}!AbsTimeCut@{AbsTimeCut}}
83     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int AbsTimeCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
84     \label{classAbsTimeCut_f7c55e8b9e801a59ea93f9b5b9212c8c}
85    
86    
87     The absolute time check.
88    
89     \begin{Desc}
90     \item[Parameters:]
91     \begin{description}
92     \item[{\em event}]The event to analyze. \end{description}
93     \end{Desc}
94     \begin{Desc}
95     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the event happened inside the time interval
96    
97     \hyperlink{AbsTimeCut_8h_838416b232e35f3a8e213039a37617a2c254e386daee724374f521ee95e31678}{ABSTIMECUT\_\-TOOEARLY} if the event happened before the begin of the time interval.
98    
99     \hyperlink{AbsTimeCut_8h_838416b232e35f3a8e213039a37617a2822616ea1321765802ee3e367b0f8be1}{ABSTIMECUT\_\-TOOLATE} if the event happened after the end of the time interval. \end{Desc}
100    
101    
102     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
103    
104     Definition at line 12 of file AbsTimeCut.cpp.
105    
106     References \_\-endDate, \_\-endTime, \_\-initDate, \_\-initTime, \_\-time, ABSTIMECUT\_\-TOOEARLY, ABSTIMECUT\_\-TOOLATE, and CUTOK.
107    
108     \subsection{Member Data Documentation}
109     \hypertarget{classAbsTimeCut_5b7824fb8b1bd398939a0abe497dcd81}{
110     \index{AbsTimeCut@{AbsTimeCut}!\_\-endDate@{\_\-endDate}}
111     \index{\_\-endDate@{\_\-endDate}!AbsTimeCut@{AbsTimeCut}}
112     \subsubsection[{\_\-endDate}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf AbsTimeCut::\_\-endDate}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
113     \label{classAbsTimeCut_5b7824fb8b1bd398939a0abe497dcd81}
114    
115    
116    
117    
118     Definition at line 63 of file AbsTimeCut.h.
119    
120     Referenced by Check().\hypertarget{classAbsTimeCut_9395725348a6e6805c8b224f6efdf039}{
121     \index{AbsTimeCut@{AbsTimeCut}!\_\-endTime@{\_\-endTime}}
122     \index{\_\-endTime@{\_\-endTime}!AbsTimeCut@{AbsTimeCut}}
123     \subsubsection[{\_\-endTime}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf AbsTimeCut::\_\-endTime}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
124     \label{classAbsTimeCut_9395725348a6e6805c8b224f6efdf039}
125    
126    
127    
128    
129     Definition at line 63 of file AbsTimeCut.h.
130    
131     Referenced by Check().\hypertarget{classAbsTimeCut_2637d0d2979325a03ac34ee3d594e443}{
132     \index{AbsTimeCut@{AbsTimeCut}!\_\-initDate@{\_\-initDate}}
133     \index{\_\-initDate@{\_\-initDate}!AbsTimeCut@{AbsTimeCut}}
134     \subsubsection[{\_\-initDate}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf AbsTimeCut::\_\-initDate}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
135     \label{classAbsTimeCut_2637d0d2979325a03ac34ee3d594e443}
136    
137    
138    
139    
140     Definition at line 63 of file AbsTimeCut.h.
141    
142     Referenced by Check().\hypertarget{classAbsTimeCut_7c329ea08fb7381a62a967275433fc0d}{
143     \index{AbsTimeCut@{AbsTimeCut}!\_\-initTime@{\_\-initTime}}
144     \index{\_\-initTime@{\_\-initTime}!AbsTimeCut@{AbsTimeCut}}
145     \subsubsection[{\_\-initTime}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf AbsTimeCut::\_\-initTime}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
146     \label{classAbsTimeCut_7c329ea08fb7381a62a967275433fc0d}
147    
148    
149    
150    
151     Definition at line 63 of file AbsTimeCut.h.
152    
153     Referenced by Check().\hypertarget{classAbsTimeCut_1568851623e9d725a527e2a4276ca34a}{
154     \index{AbsTimeCut@{AbsTimeCut}!\_\-time@{\_\-time}}
155     \index{\_\-time@{\_\-time}!AbsTimeCut@{AbsTimeCut}}
156     \subsubsection[{\_\-time}]{\setlength{\rightskip}{0pt plus 5cm}TTimeStamp {\bf AbsTimeCut::\_\-time}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
157     \label{classAbsTimeCut_1568851623e9d725a527e2a4276ca34a}
158    
159    
160    
161    
162     Definition at line 64 of file AbsTimeCut.h.
163    
164     Referenced by Check().
165    
166     The documentation for this class was generated from the following files:\begin{CompactItemize}
167     \item
168     MiscCuts/AbsTimeCut/\hyperlink{AbsTimeCut_8h}{AbsTimeCut.h}\item
169     MiscCuts/AbsTimeCut/\hyperlink{AbsTimeCut_8cpp}{AbsTimeCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23