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

Annotation of /PamCut/doc/Doxygen/html/classSaveEventsAction.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1.1.1 - (hide annotations) (download) (as text) (vendor branch)
Wed May 27 13:30:03 2009 UTC (16 years, 1 month ago) by pam-fi
Branch: DEV
CVS Tags: v0r00
Changes since 1.1: +0 -0 lines
File MIME type: text/html 
First import
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: SaveEventsAction 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>SaveEventsAction Class Reference</h1><!-- doxytag: class="SaveEventsAction" --><!-- doxytag: inherits="CollectionAction" -->An action that saves the selected events.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="SaveEventsAction_8h_source.html">SaveEventsAction.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for SaveEventsAction:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classSaveEventsAction.png" usemap="#SaveEventsAction_map" border="0" alt=""></center>
35     <map name="SaveEventsAction_map">
36     <area href="classCollectionAction.html" alt="CollectionAction" shape="rect" coords="0,0,115,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classSaveEventsAction-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="classSaveEventsAction.html#c758fdbf708778a0c0497bb65fefa75a">SaveEventsAction</a> (const char *actionName, TString outFileName, TString outOptions=TString(&quot;&quot;))</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#c758fdbf708778a0c0497bb65fefa75a"></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="classSaveEventsAction.html#08ebe8957cdc27c39a622779b0114440">~SaveEventsAction</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#08ebe8957cdc27c39a622779b0114440"></a><br></td></tr>
50     <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSaveEventsAction.html#3a59e42181c79dcd192b0be3d14a34c2">Setup</a> (PamLevel2 *events)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The setup procedure. <a href="#3a59e42181c79dcd192b0be3d14a34c2"></a><br></td></tr>
53     <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSaveEventsAction.html#47e8259afe7a68ba3c0adf3bd79fe52a">OnGood</a> (PamLevel2 *event)</td></tr>
54    
55     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fills the tree with the selected event. <a href="#47e8259afe7a68ba3c0adf3bd79fe52a"></a><br></td></tr>
56     <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSaveEventsAction.html#790f534c0a888c2a57814cd859b97270">Finalize</a> ()</td></tr>
57    
58     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes the tree of saved events to the output file. <a href="#790f534c0a888c2a57814cd859b97270"></a><br></td></tr>
59     <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
60     <tr><td class="memItemLeft" nowrap align="right" valign="top">TFile *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSaveEventsAction.html#955b11224d55598002d469b07632551f">_outTreeFile</a></td></tr>
61    
62     <tr><td class="memItemLeft" nowrap align="right" valign="top">PamLevel2 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSaveEventsAction.html#3e30ca3f79e10b745b10026ce4dcaddc">_events</a></td></tr>
63    
64     <tr><td class="memItemLeft" nowrap align="right" valign="top">TString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSaveEventsAction.html#0c1166571d97d354708f7c3fbe62d1f9">_outOptions</a></td></tr>
65    
66     </table>
67     <hr><a name="_details"></a><h2>Detailed Description</h2>
68     An action that saves the selected events.
69     <p>
70     This action saves the selected events into a ROOT file.
71     <p>Definition at line <a class="el" href="SaveEventsAction_8h_source.html#l00019">19</a> of file <a class="el" href="SaveEventsAction_8h_source.html">SaveEventsAction.h</a>.</p>
72     <hr><h2>Constructor &amp; Destructor Documentation</h2>
73     <a class="anchor" name="c758fdbf708778a0c0497bb65fefa75a"></a><!-- doxytag: member="SaveEventsAction::SaveEventsAction" ref="c758fdbf708778a0c0497bb65fefa75a" args="(const char *actionName, TString outFileName, TString outOptions=TString(&quot;&quot;))" -->
74     <div class="memitem">
75     <div class="memproto">
76     <table class="memname">
77     <tr>
78     <td class="memname">SaveEventsAction::SaveEventsAction </td>
79     <td>(</td>
80     <td class="paramtype">const char *&nbsp;</td>
81     <td class="paramname"> <em>actionName</em>, </td>
82     </tr>
83     <tr>
84     <td class="paramkey"></td>
85     <td></td>
86     <td class="paramtype">TString&nbsp;</td>
87     <td class="paramname"> <em>outFileName</em>, </td>
88     </tr>
89     <tr>
90     <td class="paramkey"></td>
91     <td></td>
92     <td class="paramtype">TString&nbsp;</td>
93     <td class="paramname"> <em>outOptions</em> = <code>TString(&quot;&quot;)</code></td><td>&nbsp;</td>
94     </tr>
95     <tr>
96     <td></td>
97     <td>)</td>
98     <td></td><td></td><td></td>
99     </tr>
100     </table>
101     </div>
102     <div class="memdoc">
103    
104     <p>
105     Constructor.
106     <p>
107     outOptions is to be passed as the argument of a PamLevel2::SetWhichTrees() call, so it must be encoded in a compatible format. See the PamLevel2 documentation.<p>
108     <dl compact><dt><b>Parameters:</b></dt><dd>
109     <table border="0" cellspacing="2" cellpadding="0">
110     <tr><td valign="top"></td><td valign="top"><em>actionName</em>&nbsp;</td><td>The action's name. </td></tr>
111     <tr><td valign="top"></td><td valign="top"><em>outFileName</em>&nbsp;</td><td>The output file name, with path (absolute or relative). </td></tr>
112     <tr><td valign="top"></td><td valign="top"><em>outOptions</em>&nbsp;</td><td>The output options. </td></tr>
113     </table>
114     </dl>
115    
116     <p>Definition at line <a class="el" href="SaveEventsAction_8cpp_source.html#l00012">12</a> of file <a class="el" href="SaveEventsAction_8cpp_source.html">SaveEventsAction.cpp</a>.</p>
117    
118     <p>References <a class="el" href="SaveEventsAction_8h_source.html#l00056">_outTreeFile</a>.</p>
119    
120     </div>
121     </div><p>
122     <a class="anchor" name="08ebe8957cdc27c39a622779b0114440"></a><!-- doxytag: member="SaveEventsAction::~SaveEventsAction" ref="08ebe8957cdc27c39a622779b0114440" args="()" -->
123     <div class="memitem">
124     <div class="memproto">
125     <table class="memname">
126     <tr>
127     <td class="memname">SaveEventsAction::~SaveEventsAction </td>
128     <td>(</td>
129     <td class="paramname"> </td>
130     <td>&nbsp;)&nbsp;</td>
131     <td><code> [inline]</code></td>
132     </tr>
133     </table>
134     </div>
135     <div class="memdoc">
136    
137     <p>
138     Destructor.
139     <p>
140    
141     <p>Definition at line <a class="el" href="SaveEventsAction_8h_source.html#l00034">34</a> of file <a class="el" href="SaveEventsAction_8h_source.html">SaveEventsAction.h</a>.</p>
142    
143     </div>
144     </div><p>
145     <hr><h2>Member Function Documentation</h2>
146     <a class="anchor" name="790f534c0a888c2a57814cd859b97270"></a><!-- doxytag: member="SaveEventsAction::Finalize" ref="790f534c0a888c2a57814cd859b97270" args="()" -->
147     <div class="memitem">
148     <div class="memproto">
149     <table class="memname">
150     <tr>
151     <td class="memname">void SaveEventsAction::Finalize </td>
152     <td>(</td>
153     <td class="paramname"> </td>
154     <td>&nbsp;)&nbsp;</td>
155     <td><code> [virtual]</code></td>
156     </tr>
157     </table>
158     </div>
159     <div class="memdoc">
160    
161     <p>
162     Writes the tree of saved events to the output file.
163     <p>
164    
165     <p>Implements <a class="el" href="classCollectionAction.html#c32b42fc08bc1be7b003579b633de041">CollectionAction</a>.</p>
166    
167     <p>Definition at line <a class="el" href="SaveEventsAction_8cpp_source.html#l00043">43</a> of file <a class="el" href="SaveEventsAction_8cpp_source.html">SaveEventsAction.cpp</a>.</p>
168    
169     <p>References <a class="el" href="SaveEventsAction_8h_source.html#l00057">_events</a>, and <a class="el" href="SaveEventsAction_8h_source.html#l00056">_outTreeFile</a>.</p>
170    
171     </div>
172     </div><p>
173     <a class="anchor" name="47e8259afe7a68ba3c0adf3bd79fe52a"></a><!-- doxytag: member="SaveEventsAction::OnGood" ref="47e8259afe7a68ba3c0adf3bd79fe52a" args="(PamLevel2 *event)" -->
174     <div class="memitem">
175     <div class="memproto">
176     <table class="memname">
177     <tr>
178     <td class="memname">void SaveEventsAction::OnGood </td>
179     <td>(</td>
180     <td class="paramtype">PamLevel2 *&nbsp;</td>
181     <td class="paramname"> <em>event</em> </td>
182     <td>&nbsp;)&nbsp;</td>
183     <td><code> [virtual]</code></td>
184     </tr>
185     </table>
186     </div>
187     <div class="memdoc">
188    
189     <p>
190     Fills the tree with the selected event.
191     <p>
192     <dl compact><dt><b>Parameters:</b></dt><dd>
193     <table border="0" cellspacing="2" cellpadding="0">
194     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The selected event. </td></tr>
195     </table>
196     </dl>
197    
198     <p>Implements <a class="el" href="classCollectionAction.html#801dd664020b71e8a3232e5a584d96a0">CollectionAction</a>.</p>
199    
200     <p>Definition at line <a class="el" href="SaveEventsAction_8cpp_source.html#l00038">38</a> of file <a class="el" href="SaveEventsAction_8cpp_source.html">SaveEventsAction.cpp</a>.</p>
201    
202     </div>
203     </div><p>
204     <a class="anchor" name="3a59e42181c79dcd192b0be3d14a34c2"></a><!-- doxytag: member="SaveEventsAction::Setup" ref="3a59e42181c79dcd192b0be3d14a34c2" args="(PamLevel2 *events)" -->
205     <div class="memitem">
206     <div class="memproto">
207     <table class="memname">
208     <tr>
209     <td class="memname">void SaveEventsAction::Setup </td>
210     <td>(</td>
211     <td class="paramtype">PamLevel2 *&nbsp;</td>
212     <td class="paramname"> <em>events</em> </td>
213     <td>&nbsp;)&nbsp;</td>
214     <td><code> [virtual]</code></td>
215     </tr>
216     </table>
217     </div>
218     <div class="memdoc">
219    
220     <p>
221     The setup procedure.
222     <p>
223     This routine will set the trees to be saved, by calling PamLevel2::SetWhichTrees().<p>
224     <dl compact><dt><b>Parameters:</b></dt><dd>
225     <table border="0" cellspacing="2" cellpadding="0">
226     <tr><td valign="top"></td><td valign="top"><em>events</em>&nbsp;</td><td>The events pointer. </td></tr>
227     </table>
228     </dl>
229    
230     <p>Reimplemented from <a class="el" href="classCollectionAction.html#13adbcacf5e088f7979f0644a65372b4">CollectionAction</a>.</p>
231    
232     <p>Definition at line <a class="el" href="SaveEventsAction_8cpp_source.html#l00031">31</a> of file <a class="el" href="SaveEventsAction_8cpp_source.html">SaveEventsAction.cpp</a>.</p>
233    
234     <p>References <a class="el" href="SaveEventsAction_8h_source.html#l00057">_events</a>, <a class="el" href="SaveEventsAction_8h_source.html#l00058">_outOptions</a>, and <a class="el" href="SaveEventsAction_8h_source.html#l00056">_outTreeFile</a>.</p>
235    
236     </div>
237     </div><p>
238     <hr><h2>Member Data Documentation</h2>
239     <a class="anchor" name="3e30ca3f79e10b745b10026ce4dcaddc"></a><!-- doxytag: member="SaveEventsAction::_events" ref="3e30ca3f79e10b745b10026ce4dcaddc" args="" -->
240     <div class="memitem">
241     <div class="memproto">
242     <table class="memname">
243     <tr>
244     <td class="memname">PamLevel2* <a class="el" href="classSaveEventsAction.html#3e30ca3f79e10b745b10026ce4dcaddc">SaveEventsAction::_events</a><code> [private]</code> </td>
245     </tr>
246     </table>
247     </div>
248     <div class="memdoc">
249    
250     <p>
251    
252     <p>Definition at line <a class="el" href="SaveEventsAction_8h_source.html#l00057">57</a> of file <a class="el" href="SaveEventsAction_8h_source.html">SaveEventsAction.h</a>.</p>
253    
254     <p>Referenced by <a class="el" href="SaveEventsAction_8cpp_source.html#l00043">Finalize()</a>, and <a class="el" href="SaveEventsAction_8cpp_source.html#l00031">Setup()</a>.</p>
255    
256     </div>
257     </div><p>
258     <a class="anchor" name="0c1166571d97d354708f7c3fbe62d1f9"></a><!-- doxytag: member="SaveEventsAction::_outOptions" ref="0c1166571d97d354708f7c3fbe62d1f9" args="" -->
259     <div class="memitem">
260     <div class="memproto">
261     <table class="memname">
262     <tr>
263     <td class="memname">TString <a class="el" href="classSaveEventsAction.html#0c1166571d97d354708f7c3fbe62d1f9">SaveEventsAction::_outOptions</a><code> [private]</code> </td>
264     </tr>
265     </table>
266     </div>
267     <div class="memdoc">
268    
269     <p>
270    
271     <p>Definition at line <a class="el" href="SaveEventsAction_8h_source.html#l00058">58</a> of file <a class="el" href="SaveEventsAction_8h_source.html">SaveEventsAction.h</a>.</p>
272    
273     <p>Referenced by <a class="el" href="SaveEventsAction_8cpp_source.html#l00031">Setup()</a>.</p>
274    
275     </div>
276     </div><p>
277     <a class="anchor" name="955b11224d55598002d469b07632551f"></a><!-- doxytag: member="SaveEventsAction::_outTreeFile" ref="955b11224d55598002d469b07632551f" args="" -->
278     <div class="memitem">
279     <div class="memproto">
280     <table class="memname">
281     <tr>
282     <td class="memname">TFile* <a class="el" href="classSaveEventsAction.html#955b11224d55598002d469b07632551f">SaveEventsAction::_outTreeFile</a><code> [private]</code> </td>
283     </tr>
284     </table>
285     </div>
286     <div class="memdoc">
287    
288     <p>
289    
290     <p>Definition at line <a class="el" href="SaveEventsAction_8h_source.html#l00056">56</a> of file <a class="el" href="SaveEventsAction_8h_source.html">SaveEventsAction.h</a>.</p>
291    
292     <p>Referenced by <a class="el" href="SaveEventsAction_8cpp_source.html#l00043">Finalize()</a>, <a class="el" href="SaveEventsAction_8cpp_source.html#l00012">SaveEventsAction()</a>, and <a class="el" href="SaveEventsAction_8cpp_source.html#l00031">Setup()</a>.</p>
293    
294     </div>
295     </div><p>
296     <hr>The documentation for this class was generated from the following files:<ul>
297     <li>CollectionActions/SaveEventsAction/<a class="el" href="SaveEventsAction_8h_source.html">SaveEventsAction.h</a><li>CollectionActions/SaveEventsAction/<a class="el" href="SaveEventsAction_8cpp_source.html">SaveEventsAction.cpp</a></ul>
298     </div>
299     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:42 2009 for PamCut by&nbsp;
300     <a href="http://www.doxygen.org/index.html">
301     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
302     </body>
303     </html>
  ViewVC Help
Powered by ViewVC 1.1.23