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

Annotation of /PamCut/doc/Doxygen/html/classAbsTimeCut.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:07 2009 UTC (15 years, 11 months ago) by pam-fi
Branch: MAIN
Branch point for: DEV
File MIME type: text/html 
Initial revision
1 pam-fi 1.1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2     <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3     <title>PamCut: AbsTimeCut Class Reference</title>
4     <link href="tabs.css" rel="stylesheet" type="text/css">
5     <link href="doxygen.css" rel="stylesheet" type="text/css">
6     </head><body>
7     <!-- Generated by Doxygen 1.5.9 -->
8     <div class="navigation" id="top">
9     <div class="tabs">
10     <ul>
11     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12     <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
13     <li><a href="files.html"><span>Files</span></a></li>
14     </ul>
15     </div>
16     <div class="tabs">
17     <ul>
18     <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
19     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
20     <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
21     </ul>
22     </div>
23     </div>
24     <div class="contents">
25     <h1>AbsTimeCut Class Reference</h1><!-- doxytag: class="AbsTimeCut" --><!-- doxytag: inherits="PamCut" -->A cut on absolute time.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for AbsTimeCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classAbsTimeCut.png" usemap="#AbsTimeCut_map" border="0" alt=""></center>
35     <map name="AbsTimeCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,79,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classAbsTimeCut-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
42     <tr><td></td></tr>
43     <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
44     <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#3a10b984df8c49274bbad0e794c26aa0">AbsTimeCut</a> (const char *cutName, const char *initDate, const char *initTime, const char *endDate, const char *endTime)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#3a10b984df8c49274bbad0e794c26aa0"></a><br></td></tr>
47     <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#06347d939b41bc6bb87cf6d705bef817">~AbsTimeCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#06347d939b41bc6bb87cf6d705bef817"></a><br></td></tr>
50     <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#f7c55e8b9e801a59ea93f9b5b9212c8c">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The absolute time check. <a href="#f7c55e8b9e801a59ea93f9b5b9212c8c"></a><br></td></tr>
53     <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
54     <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#2637d0d2979325a03ac34ee3d594e443">_initDate</a></td></tr>
55    
56     <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#7c329ea08fb7381a62a967275433fc0d">_initTime</a></td></tr>
57    
58     <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#5b7824fb8b1bd398939a0abe497dcd81">_endDate</a></td></tr>
59    
60     <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#9395725348a6e6805c8b224f6efdf039">_endTime</a></td></tr>
61    
62     <tr><td class="memItemLeft" nowrap align="right" valign="top">TTimeStamp&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#1568851623e9d725a527e2a4276ca34a">_time</a></td></tr>
63    
64     </table>
65     <hr><a name="_details"></a><h2>Detailed Description</h2>
66     A cut on absolute time.
67     <p>
68     This selection rejects all events recorded outside a certain time interval.
69     <p>Definition at line <a class="el" href="AbsTimeCut_8h_source.html#l00027">27</a> of file <a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>.</p>
70     <hr><h2>Constructor &amp; Destructor Documentation</h2>
71     <a class="anchor" name="3a10b984df8c49274bbad0e794c26aa0"></a><!-- doxytag: member="AbsTimeCut::AbsTimeCut" ref="3a10b984df8c49274bbad0e794c26aa0" args="(const char *cutName, const char *initDate, const char *initTime, const char *endDate, const char *endTime)" -->
72     <div class="memitem">
73     <div class="memproto">
74     <table class="memname">
75     <tr>
76     <td class="memname">AbsTimeCut::AbsTimeCut </td>
77     <td>(</td>
78     <td class="paramtype">const char *&nbsp;</td>
79     <td class="paramname"> <em>cutName</em>, </td>
80     </tr>
81     <tr>
82     <td class="paramkey"></td>
83     <td></td>
84     <td class="paramtype">const char *&nbsp;</td>
85     <td class="paramname"> <em>initDate</em>, </td>
86     </tr>
87     <tr>
88     <td class="paramkey"></td>
89     <td></td>
90     <td class="paramtype">const char *&nbsp;</td>
91     <td class="paramname"> <em>initTime</em>, </td>
92     </tr>
93     <tr>
94     <td class="paramkey"></td>
95     <td></td>
96     <td class="paramtype">const char *&nbsp;</td>
97     <td class="paramname"> <em>endDate</em>, </td>
98     </tr>
99     <tr>
100     <td class="paramkey"></td>
101     <td></td>
102     <td class="paramtype">const char *&nbsp;</td>
103     <td class="paramname"> <em>endTime</em></td><td>&nbsp;</td>
104     </tr>
105     <tr>
106     <td></td>
107     <td>)</td>
108     <td></td><td></td><td><code> [inline]</code></td>
109     </tr>
110     </table>
111     </div>
112     <div class="memdoc">
113    
114     <p>
115     Constructor.
116     <p>
117     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.<p>
118     <dl compact><dt><b>Parameters:</b></dt><dd>
119     <table border="0" cellspacing="2" cellpadding="0">
120     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name </td></tr>
121     <tr><td valign="top"></td><td valign="top"><em>initDate</em>&nbsp;</td><td>The initial date (format: YYMMDD). </td></tr>
122     <tr><td valign="top"></td><td valign="top"><em>initTime</em>&nbsp;</td><td>The initial time (format: hhmmss). </td></tr>
123     <tr><td valign="top"></td><td valign="top"><em>endDate</em>&nbsp;</td><td>The final date (format: YYMMDD);. </td></tr>
124     <tr><td valign="top"></td><td valign="top"><em>endTime</em>&nbsp;</td><td>The final time (format: hhmmss). </td></tr>
125     </table>
126     </dl>
127    
128     <p>Definition at line <a class="el" href="AbsTimeCut_8h_source.html#l00042">42</a> of file <a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>.</p>
129    
130     </div>
131     </div><p>
132     <a class="anchor" name="06347d939b41bc6bb87cf6d705bef817"></a><!-- doxytag: member="AbsTimeCut::~AbsTimeCut" ref="06347d939b41bc6bb87cf6d705bef817" args="()" -->
133     <div class="memitem">
134     <div class="memproto">
135     <table class="memname">
136     <tr>
137     <td class="memname">AbsTimeCut::~AbsTimeCut </td>
138     <td>(</td>
139     <td class="paramname"> </td>
140     <td>&nbsp;)&nbsp;</td>
141     <td><code> [inline]</code></td>
142     </tr>
143     </table>
144     </div>
145     <div class="memdoc">
146    
147     <p>
148     Destructor.
149     <p>
150    
151     <p>Definition at line <a class="el" href="AbsTimeCut_8h_source.html#l00049">49</a> of file <a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>.</p>
152    
153     </div>
154     </div><p>
155     <hr><h2>Member Function Documentation</h2>
156     <a class="anchor" name="f7c55e8b9e801a59ea93f9b5b9212c8c"></a><!-- doxytag: member="AbsTimeCut::Check" ref="f7c55e8b9e801a59ea93f9b5b9212c8c" args="(PamLevel2 *event)" -->
157     <div class="memitem">
158     <div class="memproto">
159     <table class="memname">
160     <tr>
161     <td class="memname">int AbsTimeCut::Check </td>
162     <td>(</td>
163     <td class="paramtype">PamLevel2 *&nbsp;</td>
164     <td class="paramname"> <em>event</em> </td>
165     <td>&nbsp;)&nbsp;</td>
166     <td><code> [virtual]</code></td>
167     </tr>
168     </table>
169     </div>
170     <div class="memdoc">
171    
172     <p>
173     The absolute time check.
174     <p>
175     <dl compact><dt><b>Parameters:</b></dt><dd>
176     <table border="0" cellspacing="2" cellpadding="0">
177     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
178     </table>
179     </dl>
180     <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="CommonDefs_8h.html#c857f4b76ae431837cbf61fd74863b6c" title="The implementations of PamCut::Check() must return this value if the event satisfy...">CUTOK</a> if the event happened inside the time interval <p>
181     <a class="el" href="AbsTimeCut_8h.html#838416b232e35f3a8e213039a37617a2c254e386daee724374f521ee95e31678">ABSTIMECUT_TOOEARLY</a> if the event happened before the begin of the time interval. <p>
182     <a class="el" href="AbsTimeCut_8h.html#838416b232e35f3a8e213039a37617a2822616ea1321765802ee3e367b0f8be1" title="&lt; The event happened before the time interval.">ABSTIMECUT_TOOLATE</a> if the event happened after the end of the time interval. </dd></dl>
183    
184     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
185    
186     <p>Definition at line <a class="el" href="AbsTimeCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="AbsTimeCut_8cpp_source.html">AbsTimeCut.cpp</a>.</p>
187    
188     <p>References <a class="el" href="AbsTimeCut_8h_source.html#l00063">_endDate</a>, <a class="el" href="AbsTimeCut_8h_source.html#l00063">_endTime</a>, <a class="el" href="AbsTimeCut_8h_source.html#l00063">_initDate</a>, <a class="el" href="AbsTimeCut_8h_source.html#l00063">_initTime</a>, <a class="el" href="AbsTimeCut_8h_source.html#l00064">_time</a>, <a class="el" href="AbsTimeCut_8h_source.html#l00018">ABSTIMECUT_TOOEARLY</a>, <a class="el" href="AbsTimeCut_8h_source.html#l00019">ABSTIMECUT_TOOLATE</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p>
189    
190     </div>
191     </div><p>
192     <hr><h2>Member Data Documentation</h2>
193     <a class="anchor" name="5b7824fb8b1bd398939a0abe497dcd81"></a><!-- doxytag: member="AbsTimeCut::_endDate" ref="5b7824fb8b1bd398939a0abe497dcd81" args="" -->
194     <div class="memitem">
195     <div class="memproto">
196     <table class="memname">
197     <tr>
198     <td class="memname">unsigned int <a class="el" href="classAbsTimeCut.html#5b7824fb8b1bd398939a0abe497dcd81">AbsTimeCut::_endDate</a><code> [private]</code> </td>
199     </tr>
200     </table>
201     </div>
202     <div class="memdoc">
203    
204     <p>
205    
206     <p>Definition at line <a class="el" href="AbsTimeCut_8h_source.html#l00063">63</a> of file <a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>.</p>
207    
208     <p>Referenced by <a class="el" href="AbsTimeCut_8cpp_source.html#l00012">Check()</a>.</p>
209    
210     </div>
211     </div><p>
212     <a class="anchor" name="9395725348a6e6805c8b224f6efdf039"></a><!-- doxytag: member="AbsTimeCut::_endTime" ref="9395725348a6e6805c8b224f6efdf039" args="" -->
213     <div class="memitem">
214     <div class="memproto">
215     <table class="memname">
216     <tr>
217     <td class="memname">unsigned int <a class="el" href="classAbsTimeCut.html#9395725348a6e6805c8b224f6efdf039">AbsTimeCut::_endTime</a><code> [private]</code> </td>
218     </tr>
219     </table>
220     </div>
221     <div class="memdoc">
222    
223     <p>
224    
225     <p>Definition at line <a class="el" href="AbsTimeCut_8h_source.html#l00063">63</a> of file <a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>.</p>
226    
227     <p>Referenced by <a class="el" href="AbsTimeCut_8cpp_source.html#l00012">Check()</a>.</p>
228    
229     </div>
230     </div><p>
231     <a class="anchor" name="2637d0d2979325a03ac34ee3d594e443"></a><!-- doxytag: member="AbsTimeCut::_initDate" ref="2637d0d2979325a03ac34ee3d594e443" args="" -->
232     <div class="memitem">
233     <div class="memproto">
234     <table class="memname">
235     <tr>
236     <td class="memname">unsigned int <a class="el" href="classAbsTimeCut.html#2637d0d2979325a03ac34ee3d594e443">AbsTimeCut::_initDate</a><code> [private]</code> </td>
237     </tr>
238     </table>
239     </div>
240     <div class="memdoc">
241    
242     <p>
243    
244     <p>Definition at line <a class="el" href="AbsTimeCut_8h_source.html#l00063">63</a> of file <a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>.</p>
245    
246     <p>Referenced by <a class="el" href="AbsTimeCut_8cpp_source.html#l00012">Check()</a>.</p>
247    
248     </div>
249     </div><p>
250     <a class="anchor" name="7c329ea08fb7381a62a967275433fc0d"></a><!-- doxytag: member="AbsTimeCut::_initTime" ref="7c329ea08fb7381a62a967275433fc0d" args="" -->
251     <div class="memitem">
252     <div class="memproto">
253     <table class="memname">
254     <tr>
255     <td class="memname">unsigned int <a class="el" href="classAbsTimeCut.html#7c329ea08fb7381a62a967275433fc0d">AbsTimeCut::_initTime</a><code> [private]</code> </td>
256     </tr>
257     </table>
258     </div>
259     <div class="memdoc">
260    
261     <p>
262    
263     <p>Definition at line <a class="el" href="AbsTimeCut_8h_source.html#l00063">63</a> of file <a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>.</p>
264    
265     <p>Referenced by <a class="el" href="AbsTimeCut_8cpp_source.html#l00012">Check()</a>.</p>
266    
267     </div>
268     </div><p>
269     <a class="anchor" name="1568851623e9d725a527e2a4276ca34a"></a><!-- doxytag: member="AbsTimeCut::_time" ref="1568851623e9d725a527e2a4276ca34a" args="" -->
270     <div class="memitem">
271     <div class="memproto">
272     <table class="memname">
273     <tr>
274     <td class="memname">TTimeStamp <a class="el" href="classAbsTimeCut.html#1568851623e9d725a527e2a4276ca34a">AbsTimeCut::_time</a><code> [private]</code> </td>
275     </tr>
276     </table>
277     </div>
278     <div class="memdoc">
279    
280     <p>
281    
282     <p>Definition at line <a class="el" href="AbsTimeCut_8h_source.html#l00064">64</a> of file <a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a>.</p>
283    
284     <p>Referenced by <a class="el" href="AbsTimeCut_8cpp_source.html#l00012">Check()</a>.</p>
285    
286     </div>
287     </div><p>
288     <hr>The documentation for this class was generated from the following files:<ul>
289     <li>MiscCuts/AbsTimeCut/<a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a><li>MiscCuts/AbsTimeCut/<a class="el" href="AbsTimeCut_8cpp_source.html">AbsTimeCut.cpp</a></ul>
290     </div>
291     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:29 2009 for PamCut by&nbsp;
292     <a href="http://www.doxygen.org/index.html">
293     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
294     </body>
295     </html>
  ViewVC Help
Powered by ViewVC 1.1.23