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: BlindCutCollection 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>BlindCutCollection Class Reference</h1><!-- doxytag: class="BlindCutCollection" --><!-- doxytag: inherits="PamCutCollection" -->A cut collection which applies all the cuts. |
26 |
<a href="#_details">More...</a> |
27 |
<p> |
28 |
<code>#include <<a class="el" href="BlindCutCollection_8h_source.html">BlindCutCollection.h</a>></code> |
29 |
<p> |
30 |
<div class="dynheader"> |
31 |
Inheritance diagram for BlindCutCollection:</div> |
32 |
<div class="dynsection"> |
33 |
|
34 |
<p><center><img src="classBlindCutCollection.png" usemap="#BlindCutCollection_map" border="0" alt=""></center> |
35 |
<map name="BlindCutCollection_map"> |
36 |
<area href="classPamCutCollection.html" alt="PamCutCollection" shape="rect" coords="0,56,144,80"> |
37 |
<area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,144,24"> |
38 |
<area href="classSmartBlindCollection.html" alt="SmartBlindCollection" shape="rect" coords="0,168,144,192"> |
39 |
<area href="classVerboseBlindCollection.html" alt="VerboseBlindCollection" shape="rect" coords="0,224,144,248"> |
40 |
</map> |
41 |
</div> |
42 |
|
43 |
<p> |
44 |
<a href="classBlindCutCollection-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
45 |
<tr><td></td></tr> |
46 |
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBlindCutCollection.html#65456bdc6e25ee98acc53ff8c0f9c3a5">BlindCutCollection</a> (const char *collectionName)</td></tr> |
48 |
|
49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#65456bdc6e25ee98acc53ff8c0f9c3a5"></a><br></td></tr> |
50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBlindCutCollection.html#3d7801972fd6d7f5b7da7790d5593259">~BlindCutCollection</a> ()</td></tr> |
51 |
|
52 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#3d7801972fd6d7f5b7da7790d5593259"></a><br></td></tr> |
53 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBlindCutCollection.html#016ee86612e57a50f03c8469d3ed9d1f">Check</a> (PamLevel2 *event)</td></tr> |
54 |
|
55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks all the cuts. <a href="#016ee86612e57a50f03c8469d3ed9d1f"></a><br></td></tr> |
56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBlindCutCollection.html#8d387de8cbc54ff0eab8cff220b49c20">ApplyCut</a> (PamLevel2 *event)</td></tr> |
57 |
|
58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Applies all the cuts to the current event. <a href="#8d387de8cbc54ff0eab8cff220b49c20"></a><br></td></tr> |
59 |
</table> |
60 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
61 |
A cut collection which applies all the cuts. |
62 |
<p> |
63 |
This cut collection will apply all the cuts it contains to the events, even if some of them are not satisfied. |
64 |
<p>Definition at line <a class="el" href="BlindCutCollection_8h_source.html#l00020">20</a> of file <a class="el" href="BlindCutCollection_8h_source.html">BlindCutCollection.h</a>.</p> |
65 |
<hr><h2>Constructor & Destructor Documentation</h2> |
66 |
<a class="anchor" name="65456bdc6e25ee98acc53ff8c0f9c3a5"></a><!-- doxytag: member="BlindCutCollection::BlindCutCollection" ref="65456bdc6e25ee98acc53ff8c0f9c3a5" args="(const char *collectionName)" --> |
67 |
<div class="memitem"> |
68 |
<div class="memproto"> |
69 |
<table class="memname"> |
70 |
<tr> |
71 |
<td class="memname">BlindCutCollection::BlindCutCollection </td> |
72 |
<td>(</td> |
73 |
<td class="paramtype">const char * </td> |
74 |
<td class="paramname"> <em>collectionName</em> </td> |
75 |
<td> ) </td> |
76 |
<td><code> [inline]</code></td> |
77 |
</tr> |
78 |
</table> |
79 |
</div> |
80 |
<div class="memdoc"> |
81 |
|
82 |
<p> |
83 |
Constructor. |
84 |
<p> |
85 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
86 |
<table border="0" cellspacing="2" cellpadding="0"> |
87 |
<tr><td valign="top"></td><td valign="top"><em>collectionName</em> </td><td>The collection's name. </td></tr> |
88 |
</table> |
89 |
</dl> |
90 |
|
91 |
<p>Definition at line <a class="el" href="BlindCutCollection_8h_source.html#l00026">26</a> of file <a class="el" href="BlindCutCollection_8h_source.html">BlindCutCollection.h</a>.</p> |
92 |
|
93 |
</div> |
94 |
</div><p> |
95 |
<a class="anchor" name="3d7801972fd6d7f5b7da7790d5593259"></a><!-- doxytag: member="BlindCutCollection::~BlindCutCollection" ref="3d7801972fd6d7f5b7da7790d5593259" args="()" --> |
96 |
<div class="memitem"> |
97 |
<div class="memproto"> |
98 |
<table class="memname"> |
99 |
<tr> |
100 |
<td class="memname">BlindCutCollection::~BlindCutCollection </td> |
101 |
<td>(</td> |
102 |
<td class="paramname"> </td> |
103 |
<td> ) </td> |
104 |
<td><code> [inline]</code></td> |
105 |
</tr> |
106 |
</table> |
107 |
</div> |
108 |
<div class="memdoc"> |
109 |
|
110 |
<p> |
111 |
Destructor. |
112 |
<p> |
113 |
|
114 |
<p>Definition at line <a class="el" href="BlindCutCollection_8h_source.html#l00031">31</a> of file <a class="el" href="BlindCutCollection_8h_source.html">BlindCutCollection.h</a>.</p> |
115 |
|
116 |
</div> |
117 |
</div><p> |
118 |
<hr><h2>Member Function Documentation</h2> |
119 |
<a class="anchor" name="8d387de8cbc54ff0eab8cff220b49c20"></a><!-- doxytag: member="BlindCutCollection::ApplyCut" ref="8d387de8cbc54ff0eab8cff220b49c20" args="(PamLevel2 *event)" --> |
120 |
<div class="memitem"> |
121 |
<div class="memproto"> |
122 |
<table class="memname"> |
123 |
<tr> |
124 |
<td class="memname">int BlindCutCollection::ApplyCut </td> |
125 |
<td>(</td> |
126 |
<td class="paramtype">PamLevel2 * </td> |
127 |
<td class="paramname"> <em>event</em> </td> |
128 |
<td> ) </td> |
129 |
<td><code> [virtual]</code></td> |
130 |
</tr> |
131 |
</table> |
132 |
</div> |
133 |
<div class="memdoc"> |
134 |
|
135 |
<p> |
136 |
Applies all the cuts to the current event. |
137 |
<p> |
138 |
This routine works pretty much like the redefinition of <a class="el" href="classBlindCutCollection.html#016ee86612e57a50f03c8469d3ed9d1f" title="Checks all the cuts.">Check()</a>, calling <a class="el" href="classBlindCutCollection.html#8d387de8cbc54ff0eab8cff220b49c20" title="Applies all the cuts to the current event.">ApplyCut()</a> (instead of <a class="el" href="classBlindCutCollection.html#016ee86612e57a50f03c8469d3ed9d1f" title="Checks all the cuts.">Check()</a> )for each cut. However, if a cut fails, it does not stops but continues until all the cuts are evaluated. If all the cuts are successful, on exit it calls <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985" title="Post-selection tasks.">OnGood()</a>; if a single cut failed, it calls <a class="el" href="classPamCut.html#cbb3b507d79f20878fac4392ffa57acb" title="Post-selection tasks.">OnBad()</a>, passing the index of the first failed cut as selectionResult.<p> |
139 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
140 |
<table border="0" cellspacing="2" cellpadding="0"> |
141 |
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The event to analyze. </td></tr> |
142 |
</table> |
143 |
</dl> |
144 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>same return values as <a class="el" href="classBlindCutCollection.html#016ee86612e57a50f03c8469d3ed9d1f" title="Checks all the cuts.">Check()</a>. </dd></dl> |
145 |
|
146 |
<p>Reimplemented from <a class="el" href="classPamCutCollection.html#e7af429a3afef3685cbd5aa076ef96e5">PamCutCollection</a>.</p> |
147 |
|
148 |
<p>Definition at line <a class="el" href="BlindCutCollection_8cpp_source.html#l00029">29</a> of file <a class="el" href="BlindCutCollection_8cpp_source.html">BlindCutCollection.cpp</a>.</p> |
149 |
|
150 |
<p>References <a class="el" href="PamCutBase_8h_source.html#l00261">PamCutCollection::_cuts</a>, <a class="el" href="PamCutBase_8h_source.html#l00158">PamCut::_nEv</a>, <a class="el" href="PamCutBase_8h_source.html#l00159">PamCut::_nGood</a>, <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>, <a class="el" href="PamCutBase_8h_source.html#l00087">PamCut::OnBad()</a>, and <a class="el" href="PamCutBase_8h_source.html#l00076">PamCut::OnGood()</a>.</p> |
151 |
|
152 |
</div> |
153 |
</div><p> |
154 |
<a class="anchor" name="016ee86612e57a50f03c8469d3ed9d1f"></a><!-- doxytag: member="BlindCutCollection::Check" ref="016ee86612e57a50f03c8469d3ed9d1f" args="(PamLevel2 *event)" --> |
155 |
<div class="memitem"> |
156 |
<div class="memproto"> |
157 |
<table class="memname"> |
158 |
<tr> |
159 |
<td class="memname">int BlindCutCollection::Check </td> |
160 |
<td>(</td> |
161 |
<td class="paramtype">PamLevel2 * </td> |
162 |
<td class="paramname"> <em>event</em> </td> |
163 |
<td> ) </td> |
164 |
<td><code> [virtual]</code></td> |
165 |
</tr> |
166 |
</table> |
167 |
</div> |
168 |
<div class="memdoc"> |
169 |
|
170 |
<p> |
171 |
Checks all the cuts. |
172 |
<p> |
173 |
This method checks all the cuts for the current event. It exits only after all the cuts have been evaluated. Note that it doesn't call <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985" title="Post-selection tasks.">OnGood()</a> nor <a class="el" href="classPamCut.html#cbb3b507d79f20878fac4392ffa57acb" title="Post-selection tasks.">OnBad()</a>, not even for the <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a> objects in the collection. <dl class="return" compact><dt><b>Returns:</b></dt><dd>the index of the first failed cut (range: [0, #cuts-1], see <a class="el" href="classPamCutCollection.html#6dc6a92a7ee9243f567a2a244e1e5685" title="Adds a cut to the cut collection This routine adds a cut to the collection. These...">AddCut()</a>); \ <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 satisfies all the cuts. </dd></dl> |
174 |
|
175 |
<p>Reimplemented from <a class="el" href="classPamCutCollection.html#85f04cef7b560a37061391dd397813a7">PamCutCollection</a>.</p> |
176 |
|
177 |
<p>Definition at line <a class="el" href="BlindCutCollection_8cpp_source.html#l00012">12</a> of file <a class="el" href="BlindCutCollection_8cpp_source.html">BlindCutCollection.cpp</a>.</p> |
178 |
|
179 |
<p>References <a class="el" href="PamCutBase_8h_source.html#l00261">PamCutCollection::_cuts</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p> |
180 |
|
181 |
</div> |
182 |
</div><p> |
183 |
<hr>The documentation for this class was generated from the following files:<ul> |
184 |
<li>Collections/BlindCutCollection/<a class="el" href="BlindCutCollection_8h_source.html">BlindCutCollection.h</a><li>Collections/BlindCutCollection/<a class="el" href="BlindCutCollection_8cpp_source.html">BlindCutCollection.cpp</a></ul> |
185 |
</div> |
186 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:30 2009 for PamCut by |
187 |
<a href="http://www.doxygen.org/index.html"> |
188 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
189 |
</body> |
190 |
</html> |