Doxygen/html/classPktQualCut.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>PamCut: PktQualCut Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>PktQualCut Class Reference</h1><!-- doxytag: class="PktQualCut" --><!-- doxytag: inherits="PamCut" -->The packet number quality cut.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PktQualCut:</div>
<div class="dynsection">

<p><center><img src="classPktQualCut.png" usemap="#PktQualCut_map" border="0" alt=""></center>
<map name="PktQualCut_map">
<area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,75,24">
</map>
</div>

<p>
<a href="classPktQualCut-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1129fbe226c512b9c6f8499968306faa"></a><!-- doxytag: member="PktQualCut::PktQualCut" ref="1129fbe226c512b9c6f8499968306faa" args="(const char *cutName)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPktQualCut.html#1129fbe226c512b9c6f8499968306faa">PktQualCut</a> (const char *cutName)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4937386b676871035dca05bb4e67889"></a><!-- doxytag: member="PktQualCut::~PktQualCut" ref="f4937386b676871035dca05bb4e67889" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPktQualCut.html#f4937386b676871035dca05bb4e67889">~PktQualCut</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
<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>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The packet number quality check.  <a href="#80b1473a595cd2536ae434212bbe00fc"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The packet number quality cut. 
<p>
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. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="80b1473a595cd2536ae434212bbe00fc"></a><!-- doxytag: member="PktQualCut::Check" ref="80b1473a595cd2536ae434212bbe00fc" args="(PamLevel2 *event)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PktQualCut::Check           </td>
          <td>(</td>
          <td class="paramtype">PamLevel2 *&nbsp;</td>
          <td class="paramname"> <em>event</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The packet number quality check. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
  </table>
</dl>
<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>
<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>
<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>

<p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>MiscCuts/PktQualCut/<a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a><li>MiscCuts/PktQualCut/<a class="el" href="PktQualCut_8cpp.html">PktQualCut.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:03 2009 for PamCut by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
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 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 List</span></a></li>
19	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
20	<li><a href="functions.html"><span>Class 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 <<a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a>></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"><a class="anchor" name="1129fbe226c512b9c6f8499968306faa"></a><!-- doxytag: member="PktQualCut::PktQualCut" ref="1129fbe226c512b9c6f8499968306faa" args="(const char *cutName)" -->
45	</td><td class="memItemRight" valign="bottom"><a class="el" href="classPktQualCut.html#1129fbe226c512b9c6f8499968306faa">PktQualCut</a> (const char *cutName)</td></tr>
46
47	<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br></td></tr>
48	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4937386b676871035dca05bb4e67889"></a><!-- doxytag: member="PktQualCut::~PktQualCut" ref="f4937386b676871035dca05bb4e67889" args="()" -->
49	</td><td class="memItemRight" valign="bottom"><a class="el" href="classPktQualCut.html#f4937386b676871035dca05bb4e67889">~PktQualCut</a> ()</td></tr>
50
51	<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
52	<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPktQualCut.html#80b1473a595cd2536ae434212bbe00fc">Check</a> (PamLevel2 *event)</td></tr>
53
54	<tr><td class="mdescLeft"> </td><td class="mdescRight">The packet number quality check. <a href="#80b1473a595cd2536ae434212bbe00fc"></a><br></td></tr>
55	</table>
56	<hr><a name="_details"></a><h2>Detailed Description</h2>
57	The packet number quality cut.
58	<p>
59	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. <hr><h2>Member Function Documentation</h2>
60	<a class="anchor" name="80b1473a595cd2536ae434212bbe00fc"></a><!-- doxytag: member="PktQualCut::Check" ref="80b1473a595cd2536ae434212bbe00fc" args="(PamLevel2 *event)" -->
61	<div class="memitem">
62	<div class="memproto">
63	<table class="memname">
64	<tr>
65	<td class="memname">int PktQualCut::Check </td>
66	<td>(</td>
67	<td class="paramtype">PamLevel2 * </td>
68	<td class="paramname"> <em>event</em> </td>
69	<td> ) </td>
70	<td><code> [virtual]</code></td>
71	</tr>
72	</table>
73	</div>
74	<div class="memdoc">
75
76	<p>
77	The packet number quality check.
78	<p>
79	<dl compact><dt><b>Parameters:</b></dt><dd>
80	<table border="0" cellspacing="2" cellpadding="0">
81	<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The event to analyze. </td></tr>
82	</table>
83	</dl>
84	<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 > previous packet number. <p>
85	<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>
86	<a class="el" href="PktQualCut_8h.html#268e9cd01607bccd4ab9e6ec7532c738361055874a7069d9fc9fa8acc562de02" title="Discarded because the packet number is not valid.">PKT_INVALID</a> if packet number > previous packet number. </dd></dl>
87
88	<p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
89
90	</div>
91	</div><p>
92	<hr>The documentation for this class was generated from the following files:<ul>
93	<li>MiscCuts/PktQualCut/<a class="el" href="PktQualCut_8h_source.html">PktQualCut.h</a><li>MiscCuts/PktQualCut/<a class="el" href="PktQualCut_8cpp.html">PktQualCut.cpp</a></ul>
94	</div>
95	<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:03 2009 for PamCut by
96	<a href="http://www.doxygen.org/index.html">
97	<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
98	</body>
99	</html>