/[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.3 - (hide annotations) (download) (as text)
Fri Sep 25 15:41:28 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +0 -0 lines
File MIME type: text/html
FILE REMOVED
Removed from repository.

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 pam-fi 1.2 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08ebe8957cdc27c39a622779b0114440"></a><!-- doxytag: member="SaveEventsAction::~SaveEventsAction" ref="08ebe8957cdc27c39a622779b0114440" args="()" -->
48     &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSaveEventsAction.html#08ebe8957cdc27c39a622779b0114440">~SaveEventsAction</a> ()</td></tr>
49 pam-fi 1.1
50 pam-fi 1.2 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
51 pam-fi 1.1 <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>
52    
53     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The setup procedure. <a href="#3a59e42181c79dcd192b0be3d14a34c2"></a><br></td></tr>
54     <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>
55    
56     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fills the tree with the selected event. <a href="#47e8259afe7a68ba3c0adf3bd79fe52a"></a><br></td></tr>
57 pam-fi 1.2 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="790f534c0a888c2a57814cd859b97270"></a><!-- doxytag: member="SaveEventsAction::Finalize" ref="790f534c0a888c2a57814cd859b97270" args="()" -->
58     void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSaveEventsAction.html#790f534c0a888c2a57814cd859b97270">Finalize</a> ()</td></tr>
59 pam-fi 1.1
60 pam-fi 1.2 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes the tree of saved events to the output file. <br></td></tr>
61 pam-fi 1.1 </table>
62     <hr><a name="_details"></a><h2>Detailed Description</h2>
63     An action that saves the selected events.
64     <p>
65 pam-fi 1.2 This action saves the selected events into a ROOT file. <hr><h2>Constructor &amp; Destructor Documentation</h2>
66 pam-fi 1.1 <a class="anchor" name="c758fdbf708778a0c0497bb65fefa75a"></a><!-- doxytag: member="SaveEventsAction::SaveEventsAction" ref="c758fdbf708778a0c0497bb65fefa75a" args="(const char *actionName, TString outFileName, TString outOptions=TString(&quot;&quot;))" -->
67     <div class="memitem">
68     <div class="memproto">
69     <table class="memname">
70     <tr>
71     <td class="memname">SaveEventsAction::SaveEventsAction </td>
72     <td>(</td>
73     <td class="paramtype">const char *&nbsp;</td>
74     <td class="paramname"> <em>actionName</em>, </td>
75     </tr>
76     <tr>
77     <td class="paramkey"></td>
78     <td></td>
79     <td class="paramtype">TString&nbsp;</td>
80     <td class="paramname"> <em>outFileName</em>, </td>
81     </tr>
82     <tr>
83     <td class="paramkey"></td>
84     <td></td>
85     <td class="paramtype">TString&nbsp;</td>
86     <td class="paramname"> <em>outOptions</em> = <code>TString(&quot;&quot;)</code></td><td>&nbsp;</td>
87     </tr>
88     <tr>
89     <td></td>
90     <td>)</td>
91     <td></td><td></td><td></td>
92     </tr>
93     </table>
94     </div>
95     <div class="memdoc">
96    
97     <p>
98     Constructor.
99     <p>
100     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>
101     <dl compact><dt><b>Parameters:</b></dt><dd>
102     <table border="0" cellspacing="2" cellpadding="0">
103     <tr><td valign="top"></td><td valign="top"><em>actionName</em>&nbsp;</td><td>The action's name. </td></tr>
104     <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>
105     <tr><td valign="top"></td><td valign="top"><em>outOptions</em>&nbsp;</td><td>The output options. </td></tr>
106     </table>
107     </dl>
108    
109     </div>
110     </div><p>
111     <hr><h2>Member Function Documentation</h2>
112     <a class="anchor" name="47e8259afe7a68ba3c0adf3bd79fe52a"></a><!-- doxytag: member="SaveEventsAction::OnGood" ref="47e8259afe7a68ba3c0adf3bd79fe52a" args="(PamLevel2 *event)" -->
113     <div class="memitem">
114     <div class="memproto">
115     <table class="memname">
116     <tr>
117     <td class="memname">void SaveEventsAction::OnGood </td>
118     <td>(</td>
119     <td class="paramtype">PamLevel2 *&nbsp;</td>
120     <td class="paramname"> <em>event</em> </td>
121     <td>&nbsp;)&nbsp;</td>
122     <td><code> [virtual]</code></td>
123     </tr>
124     </table>
125     </div>
126     <div class="memdoc">
127    
128     <p>
129     Fills the tree with the selected event.
130     <p>
131     <dl compact><dt><b>Parameters:</b></dt><dd>
132     <table border="0" cellspacing="2" cellpadding="0">
133     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The selected event. </td></tr>
134     </table>
135     </dl>
136    
137 pam-fi 1.2 <p>Reimplemented from <a class="el" href="classCollectionAction.html#077319900b1cde36b6baca9e6699ec5a">CollectionAction</a>.</p>
138 pam-fi 1.1
139     </div>
140     </div><p>
141     <a class="anchor" name="3a59e42181c79dcd192b0be3d14a34c2"></a><!-- doxytag: member="SaveEventsAction::Setup" ref="3a59e42181c79dcd192b0be3d14a34c2" args="(PamLevel2 *events)" -->
142     <div class="memitem">
143     <div class="memproto">
144     <table class="memname">
145     <tr>
146     <td class="memname">void SaveEventsAction::Setup </td>
147     <td>(</td>
148     <td class="paramtype">PamLevel2 *&nbsp;</td>
149     <td class="paramname"> <em>events</em> </td>
150     <td>&nbsp;)&nbsp;</td>
151     <td><code> [virtual]</code></td>
152     </tr>
153     </table>
154     </div>
155     <div class="memdoc">
156    
157     <p>
158     The setup procedure.
159     <p>
160     This routine will set the trees to be saved, by calling PamLevel2::SetWhichTrees().<p>
161     <dl compact><dt><b>Parameters:</b></dt><dd>
162     <table border="0" cellspacing="2" cellpadding="0">
163     <tr><td valign="top"></td><td valign="top"><em>events</em>&nbsp;</td><td>The events pointer. </td></tr>
164     </table>
165     </dl>
166    
167     <p>Reimplemented from <a class="el" href="classCollectionAction.html#13adbcacf5e088f7979f0644a65372b4">CollectionAction</a>.</p>
168    
169     </div>
170     </div><p>
171     <hr>The documentation for this class was generated from the following files:<ul>
172 pam-fi 1.2 <li>CollectionActions/SaveEventsAction/<a class="el" href="SaveEventsAction_8h_source.html">SaveEventsAction.h</a><li>CollectionActions/SaveEventsAction/<a class="el" href="SaveEventsAction_8cpp.html">SaveEventsAction.cpp</a></ul>
173 pam-fi 1.1 </div>
174 pam-fi 1.2 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:04 2009 for PamCut by&nbsp;
175 pam-fi 1.1 <a href="http://www.doxygen.org/index.html">
176     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
177     </body>
178     </html>

  ViewVC Help
Powered by ViewVC 1.1.23