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

Contents of /PamCut/doc/Doxygen/html/classPamCutCollection.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations) (download) (as text)
Wed May 27 13:30:08 2009 UTC (16 years, 1 month ago) by pam-fi
Branch: MAIN
Branch point for: DEV
File MIME type: text/html 
Initial revision
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: PamCutCollection 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>PamCutCollection Class Reference</h1><!-- doxytag: class="PamCutCollection" --><!-- doxytag: inherits="PamCut" -->A class which applies a set of cuts to Pamela data.
26 <a href="#_details">More...</a>
27 <p>
28 <code>#include &lt;<a class="el" href="PamCutBase_8h_source.html">PamCutBase.h</a>&gt;</code>
29 <p>
30 <div class="dynheader">
31 Inheritance diagram for PamCutCollection:</div>
32 <div class="dynsection">
33
34 <p><center><img src="classPamCutCollection.png" usemap="#PamCutCollection_map" border="0" alt=""></center>
35 <map name="PamCutCollection_map">
36 <area href="classPamCut.html" alt="PamCut" shape="rect" coords="77,0,221,24">
37 <area href="classBlindCutCollection.html" alt="BlindCutCollection" shape="rect" coords="0,112,144,136">
38 <area href="classSmartCollection.html" alt="SmartCollection" shape="rect" coords="154,112,298,136">
39 <area href="classSmartBlindCollection.html" alt="SmartBlindCollection" shape="rect" coords="0,168,144,192">
40 <area href="classVerboseCollection.html" alt="VerboseCollection" shape="rect" coords="154,168,298,192">
41 <area href="classVerboseBlindCollection.html" alt="VerboseBlindCollection" shape="rect" coords="0,224,144,248">
42 </map>
43 </div>
44
45 <p>
46 <a href="classPamCutCollection-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
47 <tr><td></td></tr>
48 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#756d6cc1c69e85a0f76e7674789c5588">PamCutCollection</a> (const char *collectionName)</td></tr>
50
51 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#756d6cc1c69e85a0f76e7674789c5588"></a><br></td></tr>
52 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#932711c5f613639091adbcd851107b0c">~PamCutCollection</a> ()</td></tr>
53
54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#932711c5f613639091adbcd851107b0c"></a><br></td></tr>
55 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#6dc6a92a7ee9243f567a2a244e1e5685">AddCut</a> (<a class="el" href="classPamCut.html">PamCut</a> &amp;cut)</td></tr>
56
57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a cut to the cut collection This routine adds a cut to the collection. These are stored in a vector in the same order they are inserted (the first cut would be element 0, the second cut element 1 and so on). All the references to a "cut number" or "cut index" will refer to this numbering scheme. <a href="#6dc6a92a7ee9243f567a2a244e1e5685"></a><br></td></tr>
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#85f04cef7b560a37061391dd397813a7">Check</a> (PamLevel2 *event)</td></tr>
59
60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The basic selection. <a href="#85f04cef7b560a37061391dd397813a7"></a><br></td></tr>
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#e7af429a3afef3685cbd5aa076ef96e5">ApplyCut</a> (PamLevel2 *event)</td></tr>
62
63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Applies the cuts to the current event. <a href="#e7af429a3afef3685cbd5aa076ef96e5"></a><br></td></tr>
64 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPamCut.html">PamCut</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#55e41082749260f5cee2fd53d9fd331b">GetCut</a> (unsigned int iCut)</td></tr>
65
66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a pointer to the iCut-th cut. <a href="#55e41082749260f5cee2fd53d9fd331b"></a><br></td></tr>
67 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#231f91b82b18cf326a2912b0b515baca">GetSize</a> ()</td></tr>
68
69 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of cuts contained in the collection. <a href="#231f91b82b18cf326a2912b0b515baca"></a><br></td></tr>
70 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#982821389af5e585688611d733b3a7b0">Setup</a> (PamLevel2 *events)</td></tr>
71
72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The pre-analysis task definition. <a href="#982821389af5e585688611d733b3a7b0"></a><br></td></tr>
73 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#15785c75fb13b998422739e741bb5c01">Finalize</a> ()</td></tr>
74
75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The post-analysis task definition. <a href="#15785c75fb13b998422739e741bb5c01"></a><br></td></tr>
76 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPamCutCollection.html">PamCutCollection</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#3fb36e5fb38627f5cbffe6c23cf57d2a">operator=</a> (const <a class="el" href="classPamCutCollection.html">PamCutCollection</a> &amp;rightValue)</td></tr>
77
78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator redefinition. The assignment operator replaces the content of the LHS with that of RHS. The net effect would be that the cuts contained in the LHS are exactly the same that are in the RHS. In particular, this means that any modification to one of the cuts will propagate both to the LHS and RHS collections. Also the cut name will be copied, since the implementation invokes <a class="el" href="classPamCut.html#cff560f2c6a663345c81f95df905956e" title="The assignment operator. This operator defines how to copy a PamCut object into another...">PamCut::operator=</a>. <a href="#3fb36e5fb38627f5cbffe6c23cf57d2a"></a><br></td></tr>
79 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
80 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; <a class="el" href="classPamCut.html">PamCut</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCutCollection.html#95f91f4b81f916cb6e120ee4b5bb5403">_cuts</a></td></tr>
81
82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A vector containing pointers to <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a> objects. <a href="#95f91f4b81f916cb6e120ee4b5bb5403"></a><br></td></tr>
83 </table>
84 <hr><a name="_details"></a><h2>Detailed Description</h2>
85 A class which applies a set of cuts to Pamela data.
86 <p>
87 This is a multi-cut class, which inherits from <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a>. Indeed, a multi-cut can be seen as a cut composed by various simpler cuts; hence the interface of <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a> is also functional for <a class="el" href="classPamCutCollection.html" title="A class which applies a set of cuts to Pamela data.">PamCutCollection</a>. The <a class="el" href="classPamCutCollection.html#e7af429a3afef3685cbd5aa076ef96e5" title="Applies the cuts to the current event.">ApplyCut(PamLevel2 *event)</a> method is overridden so as all the cuts that compose the <a class="el" href="classPamCutCollection.html" title="A class which applies a set of cuts to Pamela data.">PamCutCollection</a> are applied to the events in the same order they are added to the collection. Instead, <a class="el" href="classPamCut.html#047b75499ea4457d60397ee5491adcd4" title="Applies the cut to a range of events.">Process(PamLevel2 *events, ULong_t firstEvent, ULong_t lastEvent)</a> is NOT overridden, since it performs the same task as the one in the base class: it is sufficient to override <a class="el" href="classPamCutCollection.html#85f04cef7b560a37061391dd397813a7" title="The basic selection.">Check(PamLevel2 *event)</a> to replace the single-cut evaluation with a multi-cut evaluation.
88 <p>Definition at line <a class="el" href="PamCutBase_8h_source.html#l00171">171</a> of file <a class="el" href="PamCutBase_8h_source.html">PamCutBase.h</a>.</p>
89 <hr><h2>Constructor &amp; Destructor Documentation</h2>
90 <a class="anchor" name="756d6cc1c69e85a0f76e7674789c5588"></a><!-- doxytag: member="PamCutCollection::PamCutCollection" ref="756d6cc1c69e85a0f76e7674789c5588" args="(const char *collectionName)" -->
91 <div class="memitem">
92 <div class="memproto">
93 <table class="memname">
94 <tr>
95 <td class="memname">PamCutCollection::PamCutCollection </td>
96 <td>(</td>
97 <td class="paramtype">const char *&nbsp;</td>
98 <td class="paramname"> <em>collectionName</em> </td>
99 <td>&nbsp;)&nbsp;</td>
100 <td><code> [inline]</code></td>
101 </tr>
102 </table>
103 </div>
104 <div class="memdoc">
105
106 <p>
107 Constructor.
108 <p>
109 <dl compact><dt><b>Parameters:</b></dt><dd>
110 <table border="0" cellspacing="2" cellpadding="0">
111 <tr><td valign="top"></td><td valign="top"><em>collectionName</em>&nbsp;</td><td>The collection's name. </td></tr>
112 </table>
113 </dl>
114
115 <p>Definition at line <a class="el" href="PamCutBase_8h_source.html#l00178">178</a> of file <a class="el" href="PamCutBase_8h_source.html">PamCutBase.h</a>.</p>
116
117 </div>
118 </div><p>
119 <a class="anchor" name="932711c5f613639091adbcd851107b0c"></a><!-- doxytag: member="PamCutCollection::~PamCutCollection" ref="932711c5f613639091adbcd851107b0c" args="()" -->
120 <div class="memitem">
121 <div class="memproto">
122 <table class="memname">
123 <tr>
124 <td class="memname">PamCutCollection::~PamCutCollection </td>
125 <td>(</td>
126 <td class="paramname"> </td>
127 <td>&nbsp;)&nbsp;</td>
128 <td><code> [inline]</code></td>
129 </tr>
130 </table>
131 </div>
132 <div class="memdoc">
133
134 <p>
135 Destructor.
136 <p>
137
138 <p>Definition at line <a class="el" href="PamCutBase_8h_source.html#l00183">183</a> of file <a class="el" href="PamCutBase_8h_source.html">PamCutBase.h</a>.</p>
139
140 </div>
141 </div><p>
142 <hr><h2>Member Function Documentation</h2>
143 <a class="anchor" name="6dc6a92a7ee9243f567a2a244e1e5685"></a><!-- doxytag: member="PamCutCollection::AddCut" ref="6dc6a92a7ee9243f567a2a244e1e5685" args="(PamCut &amp;cut)" -->
144 <div class="memitem">
145 <div class="memproto">
146 <table class="memname">
147 <tr>
148 <td class="memname">void PamCutCollection::AddCut </td>
149 <td>(</td>
150 <td class="paramtype"><a class="el" href="classPamCut.html">PamCut</a> &amp;&nbsp;</td>
151 <td class="paramname"> <em>cut</em> </td>
152 <td>&nbsp;)&nbsp;</td>
153 <td></td>
154 </tr>
155 </table>
156 </div>
157 <div class="memdoc">
158
159 <p>
160 Adds a cut to the cut collection This routine adds a cut to the collection. These are stored in a vector in the same order they are inserted (the first cut would be element 0, the second cut element 1 and so on). All the references to a "cut number" or "cut index" will refer to this numbering scheme.
161 <p>
162 <dl compact><dt><b>Parameters:</b></dt><dd>
163 <table border="0" cellspacing="2" cellpadding="0">
164 <tr><td valign="top"></td><td valign="top"><em>cut</em>&nbsp;</td><td>The PamCut-derived object to add to the collection. </td></tr>
165 </table>
166 </dl>
167
168 <p>Definition at line <a class="el" href="PamCutBase_8cpp_source.html#l00074">74</a> of file <a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a>.</p>
169
170 <p>References <a class="el" href="PamCutBase_8h_source.html#l00261">_cuts</a>.</p>
171
172 </div>
173 </div><p>
174 <a class="anchor" name="e7af429a3afef3685cbd5aa076ef96e5"></a><!-- doxytag: member="PamCutCollection::ApplyCut" ref="e7af429a3afef3685cbd5aa076ef96e5" args="(PamLevel2 *event)" -->
175 <div class="memitem">
176 <div class="memproto">
177 <table class="memname">
178 <tr>
179 <td class="memname">int PamCutCollection::ApplyCut </td>
180 <td>(</td>
181 <td class="paramtype">PamLevel2 *&nbsp;</td>
182 <td class="paramname"> <em>event</em> </td>
183 <td>&nbsp;)&nbsp;</td>
184 <td><code> [virtual]</code></td>
185 </tr>
186 </table>
187 </div>
188 <div class="memdoc">
189
190 <p>
191 Applies the cuts to the current event.
192 <p>
193 This routine works pretty much like the redefinition of <a class="el" href="classPamCutCollection.html#85f04cef7b560a37061391dd397813a7" title="The basic selection.">Check()</a>, calling <a class="el" href="classPamCutCollection.html#e7af429a3afef3685cbd5aa076ef96e5" title="Applies the cuts to the current event.">ApplyCut()</a> (instead of <a class="el" href="classPamCutCollection.html#85f04cef7b560a37061391dd397813a7" title="The basic selection.">Check()</a> )for each cut. If a cut fails, it calls <a class="el" href="classPamCut.html#cbb3b507d79f20878fac4392ffa57acb" title="Post-selection tasks.">OnBad()</a>, passing the index of the failed cut as the selectionResult argument. If all the cuts are successful, it calls <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985" title="Post-selection tasks.">OnGood()</a>.<p>
194 <dl compact><dt><b>Parameters:</b></dt><dd>
195 <table border="0" cellspacing="2" cellpadding="0">
196 <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
197 </table>
198 </dl>
199 <dl class="return" compact><dt><b>Returns:</b></dt><dd>same return values as <a class="el" href="classPamCutCollection.html#85f04cef7b560a37061391dd397813a7" title="The basic selection.">Check()</a>. </dd></dl>
200
201 <p>Reimplemented from <a class="el" href="classPamCut.html#132a1a7cf365ff28eca38b7dda1acb7f">PamCut</a>.</p>
202
203 <p>Reimplemented in <a class="el" href="classBlindCutCollection.html#8d387de8cbc54ff0eab8cff220b49c20">BlindCutCollection</a>.</p>
204
205 <p>Definition at line <a class="el" href="PamCutBase_8cpp_source.html#l00094">94</a> of file <a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a>.</p>
206
207 <p>References <a class="el" href="PamCutBase_8h_source.html#l00261">_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>
208
209 </div>
210 </div><p>
211 <a class="anchor" name="85f04cef7b560a37061391dd397813a7"></a><!-- doxytag: member="PamCutCollection::Check" ref="85f04cef7b560a37061391dd397813a7" args="(PamLevel2 *event)" -->
212 <div class="memitem">
213 <div class="memproto">
214 <table class="memname">
215 <tr>
216 <td class="memname">int PamCutCollection::Check </td>
217 <td>(</td>
218 <td class="paramtype">PamLevel2 *&nbsp;</td>
219 <td class="paramname"> <em>event</em> </td>
220 <td>&nbsp;)&nbsp;</td>
221 <td><code> [virtual]</code></td>
222 </tr>
223 </table>
224 </div>
225 <div class="memdoc">
226
227 <p>
228 The basic selection.
229 <p>
230 Like in the mother class, this method performs a basic check on the current event: it calls <a class="el" href="classPamCutCollection.html#85f04cef7b560a37061391dd397813a7" title="The basic selection.">Check()</a> for each cut previously added with <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>, exiting if one of them is not satisfied.<p>
231 <dl class="return" compact><dt><b>Returns:</b></dt><dd>the index of the 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>
232
233 <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
234
235 <p>Reimplemented in <a class="el" href="classBlindCutCollection.html#016ee86612e57a50f03c8469d3ed9d1f">BlindCutCollection</a>.</p>
236
237 <p>Definition at line <a class="el" href="PamCutBase_8cpp_source.html#l00078">78</a> of file <a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a>.</p>
238
239 <p>References <a class="el" href="PamCutBase_8h_source.html#l00261">_cuts</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p>
240
241 </div>
242 </div><p>
243 <a class="anchor" name="15785c75fb13b998422739e741bb5c01"></a><!-- doxytag: member="PamCutCollection::Finalize" ref="15785c75fb13b998422739e741bb5c01" args="()" -->
244 <div class="memitem">
245 <div class="memproto">
246 <table class="memname">
247 <tr>
248 <td class="memname">void PamCutCollection::Finalize </td>
249 <td>(</td>
250 <td class="paramname"> </td>
251 <td>&nbsp;)&nbsp;</td>
252 <td><code> [virtual]</code></td>
253 </tr>
254 </table>
255 </div>
256 <div class="memdoc">
257
258 <p>
259 The post-analysis task definition.
260 <p>
261 This override of the <a class="el" href="classPamCutCollection.html#15785c75fb13b998422739e741bb5c01" title="The post-analysis task definition.">Finalize()</a> method calls <a class="el" href="classPamCut.html#fd74c1565552cabe4aced316df803737" title="The post-analysis task definition.">PamCut::Finalize()</a> and then the <a class="el" href="classPamCutCollection.html#15785c75fb13b998422739e741bb5c01" title="The post-analysis task definition.">Finalize()</a> method of each cut contained in the collection, in the same order.
262 <p>Reimplemented from <a class="el" href="classPamCut.html#fd74c1565552cabe4aced316df803737">PamCut</a>.</p>
263
264 <p>Reimplemented in <a class="el" href="classSmartBlindCollection.html#a78ee7b18b0913554e64b4e560453167">SmartBlindCollection</a>, <a class="el" href="classSmartCollection.html#8105730615ad127a482a7fb399695977">SmartCollection</a>, <a class="el" href="classVerboseBlindCollection.html#43d6ea7b5ea35c5dbb342e23584b79ee">VerboseBlindCollection</a>, and <a class="el" href="classVerboseCollection.html#3fcdf28d50507d772647d4306a78f3cc">VerboseCollection</a>.</p>
265
266 <p>Definition at line <a class="el" href="PamCutBase_8cpp_source.html#l00146">146</a> of file <a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a>.</p>
267
268 <p>References <a class="el" href="PamCutBase_8h_source.html#l00261">_cuts</a>, and <a class="el" href="PamCutBase_8cpp_source.html#l00125">GetSize()</a>.</p>
269
270 </div>
271 </div><p>
272 <a class="anchor" name="55e41082749260f5cee2fd53d9fd331b"></a><!-- doxytag: member="PamCutCollection::GetCut" ref="55e41082749260f5cee2fd53d9fd331b" args="(unsigned int iCut)" -->
273 <div class="memitem">
274 <div class="memproto">
275 <table class="memname">
276 <tr>
277 <td class="memname"><a class="el" href="classPamCut.html">PamCut</a> * PamCutCollection::GetCut </td>
278 <td>(</td>
279 <td class="paramtype">unsigned int&nbsp;</td>
280 <td class="paramname"> <em>iCut</em> </td>
281 <td>&nbsp;)&nbsp;</td>
282 <td></td>
283 </tr>
284 </table>
285 </div>
286 <div class="memdoc">
287
288 <p>
289 Returns a pointer to the iCut-th cut.
290 <p>
291 The return value of this method is a pointer to a <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a> object; hence, to use the specific method of derived cuts it must be cast to the proper cut class.<p>
292 <dl compact><dt><b>Parameters:</b></dt><dd>
293 <table border="0" cellspacing="2" cellpadding="0">
294 <tr><td valign="top"></td><td valign="top"><em>iCut</em>&nbsp;</td><td>The cut number, defined as the insertion order (from 0 to #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>). </td></tr>
295 </table>
296 </dl>
297 <dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to the iCut-th cut; NULL if the specified cut cannot be found or if no cuts are present. </dd></dl>
298
299 <p>Definition at line <a class="el" href="PamCutBase_8cpp_source.html#l00116">116</a> of file <a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a>.</p>
300
301 <p>References <a class="el" href="PamCutBase_8h_source.html#l00261">_cuts</a>.</p>
302
303 <p>Referenced by <a class="el" href="VerboseCollection_8cpp_source.html#l00013">VerboseCollection::Finalize()</a>, and <a class="el" href="VerboseBlindCollection_8cpp_source.html#l00013">VerboseBlindCollection::Finalize()</a>.</p>
304
305 </div>
306 </div><p>
307 <a class="anchor" name="231f91b82b18cf326a2912b0b515baca"></a><!-- doxytag: member="PamCutCollection::GetSize" ref="231f91b82b18cf326a2912b0b515baca" args="()" -->
308 <div class="memitem">
309 <div class="memproto">
310 <table class="memname">
311 <tr>
312 <td class="memname">unsigned int PamCutCollection::GetSize </td>
313 <td>(</td>
314 <td class="paramname"> </td>
315 <td>&nbsp;)&nbsp;</td>
316 <td></td>
317 </tr>
318 </table>
319 </div>
320 <div class="memdoc">
321
322 <p>
323 The number of cuts contained in the collection.
324 <p>
325 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of cuts </dd></dl>
326
327 <p>Definition at line <a class="el" href="PamCutBase_8cpp_source.html#l00125">125</a> of file <a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a>.</p>
328
329 <p>References <a class="el" href="PamCutBase_8h_source.html#l00261">_cuts</a>.</p>
330
331 <p>Referenced by <a class="el" href="PamCutBase_8cpp_source.html#l00146">Finalize()</a>, <a class="el" href="VerboseCollection_8cpp_source.html#l00013">VerboseCollection::Finalize()</a>, <a class="el" href="VerboseBlindCollection_8cpp_source.html#l00013">VerboseBlindCollection::Finalize()</a>, and <a class="el" href="PamCutBase_8cpp_source.html#l00137">Setup()</a>.</p>
332
333 </div>
334 </div><p>
335 <a class="anchor" name="3fb36e5fb38627f5cbffe6c23cf57d2a"></a><!-- doxytag: member="PamCutCollection::operator=" ref="3fb36e5fb38627f5cbffe6c23cf57d2a" args="(const PamCutCollection &amp;rightValue)" -->
336 <div class="memitem">
337 <div class="memproto">
338 <table class="memname">
339 <tr>
340 <td class="memname"><a class="el" href="classPamCutCollection.html">PamCutCollection</a> &amp; PamCutCollection::operator= </td>
341 <td>(</td>
342 <td class="paramtype">const <a class="el" href="classPamCutCollection.html">PamCutCollection</a> &amp;&nbsp;</td>
343 <td class="paramname"> <em>rightValue</em> </td>
344 <td>&nbsp;)&nbsp;</td>
345 <td></td>
346 </tr>
347 </table>
348 </div>
349 <div class="memdoc">
350
351 <p>
352 Assignment operator redefinition. The assignment operator replaces the content of the LHS with that of RHS. The net effect would be that the cuts contained in the LHS are exactly the same that are in the RHS. In particular, this means that any modification to one of the cuts will propagate both to the LHS and RHS collections. Also the cut name will be copied, since the implementation invokes <a class="el" href="classPamCut.html#cff560f2c6a663345c81f95df905956e" title="The assignment operator. This operator defines how to copy a PamCut object into another...">PamCut::operator=</a>.
353 <p>
354 <dl compact><dt><b>Parameters:</b></dt><dd>
355 <table border="0" cellspacing="2" cellpadding="0">
356 <tr><td valign="top"></td><td valign="top"><em>rightValue</em>&nbsp;</td><td>The RHS. </td></tr>
357 </table>
358 </dl>
359 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The new value for LHS. </dd></dl>
360
361 <p>Definition at line <a class="el" href="PamCutBase_8cpp_source.html#l00130">130</a> of file <a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a>.</p>
362
363 <p>References <a class="el" href="PamCutBase_8h_source.html#l00261">_cuts</a>.</p>
364
365 </div>
366 </div><p>
367 <a class="anchor" name="982821389af5e585688611d733b3a7b0"></a><!-- doxytag: member="PamCutCollection::Setup" ref="982821389af5e585688611d733b3a7b0" args="(PamLevel2 *events)" -->
368 <div class="memitem">
369 <div class="memproto">
370 <table class="memname">
371 <tr>
372 <td class="memname">void PamCutCollection::Setup </td>
373 <td>(</td>
374 <td class="paramtype">PamLevel2 *&nbsp;</td>
375 <td class="paramname"> <em>events</em> </td>
376 <td>&nbsp;)&nbsp;</td>
377 <td><code> [virtual]</code></td>
378 </tr>
379 </table>
380 </div>
381 <div class="memdoc">
382
383 <p>
384 The pre-analysis task definition.
385 <p>
386 This override of the <a class="el" href="classPamCutCollection.html#982821389af5e585688611d733b3a7b0" title="The pre-analysis task definition.">Setup()</a> method calls <a class="el" href="classPamCutCollection.html#982821389af5e585688611d733b3a7b0" title="The pre-analysis task definition.">Setup()</a> for the base class <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a>, and subsequently for each cut contained in the collection, in the same order the cuts were added to the collection.<p>
387 <dl compact><dt><b>Parameters:</b></dt><dd>
388 <table border="0" cellspacing="2" cellpadding="0">
389 <tr><td valign="top"></td><td valign="top"><em>events</em>&nbsp;</td><td>The PamLevel2 pointer to the events that will be analyzed. Unused, but required by the interface. </td></tr>
390 </table>
391 </dl>
392
393 <p>Reimplemented from <a class="el" href="classPamCut.html#e587828903b809c99f9ab5ba97ae6616">PamCut</a>.</p>
394
395 <p>Reimplemented in <a class="el" href="classSmartBlindCollection.html#e59d373921df00a54a8a8401a1ae2baf">SmartBlindCollection</a>, and <a class="el" href="classSmartCollection.html#9b5b11a854b9e174218ea516ceffb34c">SmartCollection</a>.</p>
396
397 <p>Definition at line <a class="el" href="PamCutBase_8cpp_source.html#l00137">137</a> of file <a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a>.</p>
398
399 <p>References <a class="el" href="PamCutBase_8h_source.html#l00261">_cuts</a>, and <a class="el" href="PamCutBase_8cpp_source.html#l00125">GetSize()</a>.</p>
400
401 </div>
402 </div><p>
403 <hr><h2>Member Data Documentation</h2>
404 <a class="anchor" name="95f91f4b81f916cb6e120ee4b5bb5403"></a><!-- doxytag: member="PamCutCollection::_cuts" ref="95f91f4b81f916cb6e120ee4b5bb5403" args="" -->
405 <div class="memitem">
406 <div class="memproto">
407 <table class="memname">
408 <tr>
409 <td class="memname">std::vector&lt;<a class="el" href="classPamCut.html">PamCut</a>*&gt; <a class="el" href="classPamCutCollection.html#95f91f4b81f916cb6e120ee4b5bb5403">PamCutCollection::_cuts</a><code> [protected]</code> </td>
410 </tr>
411 </table>
412 </div>
413 <div class="memdoc">
414
415 <p>
416 A vector containing pointers to <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a> objects.
417 <p>
418
419 <p>Definition at line <a class="el" href="PamCutBase_8h_source.html#l00261">261</a> of file <a class="el" href="PamCutBase_8h_source.html">PamCutBase.h</a>.</p>
420
421 <p>Referenced by <a class="el" href="PamCutBase_8cpp_source.html#l00074">AddCut()</a>, <a class="el" href="PamCutBase_8cpp_source.html#l00094">ApplyCut()</a>, <a class="el" href="BlindCutCollection_8cpp_source.html#l00029">BlindCutCollection::ApplyCut()</a>, <a class="el" href="PamCutBase_8cpp_source.html#l00078">Check()</a>, <a class="el" href="BlindCutCollection_8cpp_source.html#l00012">BlindCutCollection::Check()</a>, <a class="el" href="PamCutBase_8cpp_source.html#l00146">Finalize()</a>, <a class="el" href="VerboseCollection_8cpp_source.html#l00013">VerboseCollection::Finalize()</a>, <a class="el" href="VerboseBlindCollection_8cpp_source.html#l00013">VerboseBlindCollection::Finalize()</a>, <a class="el" href="PamCutBase_8cpp_source.html#l00116">GetCut()</a>, <a class="el" href="PamCutBase_8cpp_source.html#l00125">GetSize()</a>, <a class="el" href="PamCutBase_8cpp_source.html#l00130">operator=()</a>, and <a class="el" href="PamCutBase_8cpp_source.html#l00137">Setup()</a>.</p>
422
423 </div>
424 </div><p>
425 <hr>The documentation for this class was generated from the following files:<ul>
426 <li>PamCutBase/<a class="el" href="PamCutBase_8h_source.html">PamCutBase.h</a><li>PamCutBase/<a class="el" href="PamCutBase_8cpp_source.html">PamCutBase.cpp</a></ul>
427 </div>
428 <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:41 2009 for PamCut by&nbsp;
429 <a href="http://www.doxygen.org/index.html">
430 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
431 </body>
432 </html>
  ViewVC Help
Powered by ViewVC 1.1.23