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

Annotation of /PamCut/doc/Doxygen/html/classPktQualCut.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, 10 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: PktQualCut 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>PktQualCut Class Reference</h1><!-- doxytag: class="PktQualCut" --><!-- doxytag: inherits="PamCut" -->The packet number quality cut.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for PktQualCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classPktQualCut.png" usemap="#PktQualCut_map" border="0" alt=""></center>
35     <map name="PktQualCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,75,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classPktQualCut-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="classPktQualCut.html#1129fbe226c512b9c6f8499968306faa">PktQualCut</a> (const char *cutName)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#1129fbe226c512b9c6f8499968306faa"></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="classPktQualCut.html#f4937386b676871035dca05bb4e67889">~PktQualCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#f4937386b676871035dca05bb4e67889"></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="classPktQualCut.html#80b1473a595cd2536ae434212bbe00fc">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The packet number quality check. <a href="#80b1473a595cd2536ae434212bbe00fc"></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">UInt_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPktQualCut.html#3cfa4a53560dfd9c43e50dc08f3299e5">_previousPkt</a></td></tr>
55    
56     <tr><td class="memItemLeft" nowrap align="right" valign="top">UInt_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPktQualCut.html#d6bae6178dbc8eb946f2d26de0049da8">_previousRun</a></td></tr>
57    
58     </table>
59     <hr><a name="_details"></a><h2>Detailed Description</h2>
60     The packet number quality cut.
61     <p>
62     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.
63     <p>Definition at line <a class="el" href="PktQualCut_8h_source.html#l00029">29</a> of file <a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a>.</p>
64     <hr><h2>Constructor &amp; Destructor Documentation</h2>
65     <a class="anchor" name="1129fbe226c512b9c6f8499968306faa"></a><!-- doxytag: member="PktQualCut::PktQualCut" ref="1129fbe226c512b9c6f8499968306faa" args="(const char *cutName)" -->
66     <div class="memitem">
67     <div class="memproto">
68     <table class="memname">
69     <tr>
70     <td class="memname">PktQualCut::PktQualCut </td>
71     <td>(</td>
72     <td class="paramtype">const char *&nbsp;</td>
73     <td class="paramname"> <em>cutName</em> </td>
74     <td>&nbsp;)&nbsp;</td>
75     <td><code> [inline]</code></td>
76     </tr>
77     </table>
78     </div>
79     <div class="memdoc">
80    
81     <p>
82     Constructor.
83     <p>
84    
85     <p>Definition at line <a class="el" href="PktQualCut_8h_source.html#l00033">33</a> of file <a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a>.</p>
86    
87     </div>
88     </div><p>
89     <a class="anchor" name="f4937386b676871035dca05bb4e67889"></a><!-- doxytag: member="PktQualCut::~PktQualCut" ref="f4937386b676871035dca05bb4e67889" args="()" -->
90     <div class="memitem">
91     <div class="memproto">
92     <table class="memname">
93     <tr>
94     <td class="memname">PktQualCut::~PktQualCut </td>
95     <td>(</td>
96     <td class="paramname"> </td>
97     <td>&nbsp;)&nbsp;</td>
98     <td><code> [inline]</code></td>
99     </tr>
100     </table>
101     </div>
102     <div class="memdoc">
103    
104     <p>
105     Destructor.
106     <p>
107    
108     <p>Definition at line <a class="el" href="PktQualCut_8h_source.html#l00037">37</a> of file <a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a>.</p>
109    
110     </div>
111     </div><p>
112     <hr><h2>Member Function Documentation</h2>
113     <a class="anchor" name="80b1473a595cd2536ae434212bbe00fc"></a><!-- doxytag: member="PktQualCut::Check" ref="80b1473a595cd2536ae434212bbe00fc" args="(PamLevel2 *event)" -->
114     <div class="memitem">
115     <div class="memproto">
116     <table class="memname">
117     <tr>
118     <td class="memname">int PktQualCut::Check </td>
119     <td>(</td>
120     <td class="paramtype">PamLevel2 *&nbsp;</td>
121     <td class="paramname"> <em>event</em> </td>
122     <td>&nbsp;)&nbsp;</td>
123     <td><code> [virtual]</code></td>
124     </tr>
125     </table>
126     </div>
127     <div class="memdoc">
128    
129     <p>
130     The packet number quality check.
131     <p>
132     <dl compact><dt><b>Parameters:</b></dt><dd>
133     <table border="0" cellspacing="2" cellpadding="0">
134     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
135     </table>
136     </dl>
137     <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 packet number &gt; previous packet number. <p>
138     <a class="el" href="PktQualCut_8h.html#268e9cd01607bccd4ab9e6ec7532c738fac77ebed2c4fc251850c9a93f5196ad" title="Discarded because it is the first event of the run.">PKT_NEWRUN</a> if the event has been discarded since it is the first of the run <p>
139     <a class="el" href="PktQualCut_8h.html#268e9cd01607bccd4ab9e6ec7532c738361055874a7069d9fc9fa8acc562de02" title="Discarded because the packet number is not valid.">PKT_INVALID</a> if packet number &gt; previous packet number. </dd></dl>
140    
141     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
142    
143     <p>Definition at line <a class="el" href="PktQualCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="PktQualCut_8cpp_source.html">PktQualCut.cpp</a>.</p>
144    
145     <p>References <a class="el" href="PktQualCut_8h_source.html#l00050">_previousPkt</a>, <a class="el" href="PktQualCut_8h_source.html#l00051">_previousRun</a>, <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>, and <a class="el" href="PktQualCut_8h_source.html#l00018">PKT_INVALID</a>.</p>
146    
147     </div>
148     </div><p>
149     <hr><h2>Member Data Documentation</h2>
150     <a class="anchor" name="3cfa4a53560dfd9c43e50dc08f3299e5"></a><!-- doxytag: member="PktQualCut::_previousPkt" ref="3cfa4a53560dfd9c43e50dc08f3299e5" args="" -->
151     <div class="memitem">
152     <div class="memproto">
153     <table class="memname">
154     <tr>
155     <td class="memname">UInt_t <a class="el" href="classPktQualCut.html#3cfa4a53560dfd9c43e50dc08f3299e5">PktQualCut::_previousPkt</a><code> [private]</code> </td>
156     </tr>
157     </table>
158     </div>
159     <div class="memdoc">
160    
161     <p>
162    
163     <p>Definition at line <a class="el" href="PktQualCut_8h_source.html#l00050">50</a> of file <a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a>.</p>
164    
165     <p>Referenced by <a class="el" href="PktQualCut_8cpp_source.html#l00012">Check()</a>.</p>
166    
167     </div>
168     </div><p>
169     <a class="anchor" name="d6bae6178dbc8eb946f2d26de0049da8"></a><!-- doxytag: member="PktQualCut::_previousRun" ref="d6bae6178dbc8eb946f2d26de0049da8" args="" -->
170     <div class="memitem">
171     <div class="memproto">
172     <table class="memname">
173     <tr>
174     <td class="memname">UInt_t <a class="el" href="classPktQualCut.html#d6bae6178dbc8eb946f2d26de0049da8">PktQualCut::_previousRun</a><code> [private]</code> </td>
175     </tr>
176     </table>
177     </div>
178     <div class="memdoc">
179    
180     <p>
181    
182     <p>Definition at line <a class="el" href="PktQualCut_8h_source.html#l00051">51</a> of file <a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a>.</p>
183    
184     <p>Referenced by <a class="el" href="PktQualCut_8cpp_source.html#l00012">Check()</a>.</p>
185    
186     </div>
187     </div><p>
188     <hr>The documentation for this class was generated from the following files:<ul>
189     <li>MiscCuts/PktQualCut/<a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a><li>MiscCuts/PktQualCut/<a class="el" href="PktQualCut_8cpp_source.html">PktQualCut.cpp</a></ul>
190     </div>
191     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:41 2009 for PamCut by&nbsp;
192     <a href="http://www.doxygen.org/index.html">
193     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
194     </body>
195     </html>
  ViewVC Help
Powered by ViewVC 1.1.23