/[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.3 - (hide annotations) (download) (as text)
Fri Sep 25 15:41:05 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +0 -0 lines
File MIME type: text/html
FILE REMOVED 
Removed from repository.
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 pam-fi 1.2 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06347d939b41bc6bb87cf6d705bef817"></a><!-- doxytag: member="AbsTimeCut::~AbsTimeCut" ref="06347d939b41bc6bb87cf6d705bef817" args="()" -->
48     &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbsTimeCut.html#06347d939b41bc6bb87cf6d705bef817">~AbsTimeCut</a> ()</td></tr>
49 pam-fi 1.1
50 pam-fi 1.2 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
51 pam-fi 1.1 <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>
52    
53     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The absolute time check. <a href="#f7c55e8b9e801a59ea93f9b5b9212c8c"></a><br></td></tr>
54     </table>
55     <hr><a name="_details"></a><h2>Detailed Description</h2>
56     A cut on absolute time.
57     <p>
58 pam-fi 1.2 This selection rejects all events recorded outside a certain time interval. <hr><h2>Constructor &amp; Destructor Documentation</h2>
59 pam-fi 1.1 <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)" -->
60     <div class="memitem">
61     <div class="memproto">
62     <table class="memname">
63     <tr>
64     <td class="memname">AbsTimeCut::AbsTimeCut </td>
65     <td>(</td>
66     <td class="paramtype">const char *&nbsp;</td>
67     <td class="paramname"> <em>cutName</em>, </td>
68     </tr>
69     <tr>
70     <td class="paramkey"></td>
71     <td></td>
72     <td class="paramtype">const char *&nbsp;</td>
73     <td class="paramname"> <em>initDate</em>, </td>
74     </tr>
75     <tr>
76     <td class="paramkey"></td>
77     <td></td>
78     <td class="paramtype">const char *&nbsp;</td>
79     <td class="paramname"> <em>initTime</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>endDate</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>endTime</em></td><td>&nbsp;</td>
92     </tr>
93     <tr>
94     <td></td>
95     <td>)</td>
96     <td></td><td></td><td><code> [inline]</code></td>
97     </tr>
98     </table>
99     </div>
100     <div class="memdoc">
101    
102     <p>
103     Constructor.
104     <p>
105     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>
106     <dl compact><dt><b>Parameters:</b></dt><dd>
107     <table border="0" cellspacing="2" cellpadding="0">
108     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name </td></tr>
109     <tr><td valign="top"></td><td valign="top"><em>initDate</em>&nbsp;</td><td>The initial date (format: YYMMDD). </td></tr>
110     <tr><td valign="top"></td><td valign="top"><em>initTime</em>&nbsp;</td><td>The initial time (format: hhmmss). </td></tr>
111     <tr><td valign="top"></td><td valign="top"><em>endDate</em>&nbsp;</td><td>The final date (format: YYMMDD);. </td></tr>
112     <tr><td valign="top"></td><td valign="top"><em>endTime</em>&nbsp;</td><td>The final time (format: hhmmss). </td></tr>
113     </table>
114     </dl>
115    
116     </div>
117     </div><p>
118     <hr><h2>Member Function Documentation</h2>
119     <a class="anchor" name="f7c55e8b9e801a59ea93f9b5b9212c8c"></a><!-- doxytag: member="AbsTimeCut::Check" ref="f7c55e8b9e801a59ea93f9b5b9212c8c" args="(PamLevel2 *event)" -->
120     <div class="memitem">
121     <div class="memproto">
122     <table class="memname">
123     <tr>
124     <td class="memname">int AbsTimeCut::Check </td>
125     <td>(</td>
126     <td class="paramtype">PamLevel2 *&nbsp;</td>
127     <td class="paramname"> <em>event</em> </td>
128     <td>&nbsp;)&nbsp;</td>
129     <td><code> [virtual]</code></td>
130     </tr>
131     </table>
132     </div>
133     <div class="memdoc">
134    
135     <p>
136     The absolute time check.
137     <p>
138     <dl compact><dt><b>Parameters:</b></dt><dd>
139     <table border="0" cellspacing="2" cellpadding="0">
140     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
141     </table>
142     </dl>
143     <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>
144 pam-fi 1.2 <a class="el" href="AbsTimeCut_8h.html#838416b232e35f3a8e213039a37617a2c254e386daee724374f521ee95e31678" title="The event happened before the time interval.">ABSTIMECUT_TOOEARLY</a> if the event happened before the begin of the time interval. <p>
145     <a class="el" href="AbsTimeCut_8h.html#838416b232e35f3a8e213039a37617a2822616ea1321765802ee3e367b0f8be1" title="The event happened after the time interval.">ABSTIMECUT_TOOLATE</a> if the event happened after the end of the time interval. </dd></dl>
146 pam-fi 1.1
147     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
148    
149     </div>
150     </div><p>
151     <hr>The documentation for this class was generated from the following files:<ul>
152 pam-fi 1.2 <li>MiscCuts/AbsTimeCut/<a class="el" href="AbsTimeCut_8h_source.html">AbsTimeCut.h</a><li>MiscCuts/AbsTimeCut/<a class="el" href="AbsTimeCut_8cpp.html">AbsTimeCut.cpp</a></ul>
153 pam-fi 1.1 </div>
154 pam-fi 1.2 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:08:59 2009 for PamCut by&nbsp;
155 pam-fi 1.1 <a href="http://www.doxygen.org/index.html">
156     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
157     </body>
158     </html>
  ViewVC Help
Powered by ViewVC 1.1.23