1 |
\hypertarget{classSaveEventsAction}{ |
2 |
\section{SaveEventsAction Class Reference} |
3 |
\label{classSaveEventsAction}\index{SaveEventsAction@{SaveEventsAction}} |
4 |
} |
5 |
An action that saves the selected events. |
6 |
|
7 |
|
8 |
{\tt \#include $<$SaveEventsAction.h$>$} |
9 |
|
10 |
Inheritance diagram for SaveEventsAction::\begin{figure}[H] |
11 |
\begin{center} |
12 |
\leavevmode |
13 |
\includegraphics[height=2cm]{classSaveEventsAction} |
14 |
\end{center} |
15 |
\end{figure} |
16 |
\subsection*{Public Member Functions} |
17 |
\begin{CompactItemize} |
18 |
\item |
19 |
\hyperlink{classSaveEventsAction_c758fdbf708778a0c0497bb65fefa75a}{SaveEventsAction} (const char $\ast$actionName, TString outFileName, TString outOptions=TString(\char`\"{}\char`\"{})) |
20 |
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item |
21 |
\hypertarget{classSaveEventsAction_08ebe8957cdc27c39a622779b0114440}{ |
22 |
\hyperlink{classSaveEventsAction_08ebe8957cdc27c39a622779b0114440}{$\sim$SaveEventsAction} ()} |
23 |
\label{classSaveEventsAction_08ebe8957cdc27c39a622779b0114440} |
24 |
|
25 |
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item |
26 |
void \hyperlink{classSaveEventsAction_3a59e42181c79dcd192b0be3d14a34c2}{Setup} (PamLevel2 $\ast$events) |
27 |
\begin{CompactList}\small\item\em The setup procedure. \item\end{CompactList}\item |
28 |
void \hyperlink{classSaveEventsAction_47e8259afe7a68ba3c0adf3bd79fe52a}{OnGood} (PamLevel2 $\ast$event) |
29 |
\begin{CompactList}\small\item\em Fills the tree with the selected event. \item\end{CompactList}\item |
30 |
\hypertarget{classSaveEventsAction_790f534c0a888c2a57814cd859b97270}{ |
31 |
void \hyperlink{classSaveEventsAction_790f534c0a888c2a57814cd859b97270}{Finalize} ()} |
32 |
\label{classSaveEventsAction_790f534c0a888c2a57814cd859b97270} |
33 |
|
34 |
\begin{CompactList}\small\item\em Writes the tree of saved events to the output file. \item\end{CompactList}\end{CompactItemize} |
35 |
|
36 |
|
37 |
\subsection{Detailed Description} |
38 |
An action that saves the selected events. |
39 |
|
40 |
This action saves the selected events into a ROOT file. |
41 |
|
42 |
\subsection{Constructor \& Destructor Documentation} |
43 |
\hypertarget{classSaveEventsAction_c758fdbf708778a0c0497bb65fefa75a}{ |
44 |
\index{SaveEventsAction@{SaveEventsAction}!SaveEventsAction@{SaveEventsAction}} |
45 |
\index{SaveEventsAction@{SaveEventsAction}!SaveEventsAction@{SaveEventsAction}} |
46 |
\subsubsection[{SaveEventsAction}]{\setlength{\rightskip}{0pt plus 5cm}SaveEventsAction::SaveEventsAction (const char $\ast$ {\em actionName}, \/ TString {\em outFileName}, \/ TString {\em outOptions} = {\tt TString(\char`\"{}\char`\"{})})}} |
47 |
\label{classSaveEventsAction_c758fdbf708778a0c0497bb65fefa75a} |
48 |
|
49 |
|
50 |
Constructor. |
51 |
|
52 |
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. |
53 |
|
54 |
\begin{Desc} |
55 |
\item[Parameters:] |
56 |
\begin{description} |
57 |
\item[{\em actionName}]The action's name. \item[{\em outFileName}]The output file name, with path (absolute or relative). \item[{\em outOptions}]The output options. \end{description} |
58 |
\end{Desc} |
59 |
|
60 |
|
61 |
\subsection{Member Function Documentation} |
62 |
\hypertarget{classSaveEventsAction_47e8259afe7a68ba3c0adf3bd79fe52a}{ |
63 |
\index{SaveEventsAction@{SaveEventsAction}!OnGood@{OnGood}} |
64 |
\index{OnGood@{OnGood}!SaveEventsAction@{SaveEventsAction}} |
65 |
\subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void SaveEventsAction::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
66 |
\label{classSaveEventsAction_47e8259afe7a68ba3c0adf3bd79fe52a} |
67 |
|
68 |
|
69 |
Fills the tree with the selected event. |
70 |
|
71 |
\begin{Desc} |
72 |
\item[Parameters:] |
73 |
\begin{description} |
74 |
\item[{\em event}]The selected event. \end{description} |
75 |
\end{Desc} |
76 |
|
77 |
|
78 |
Reimplemented from \hyperlink{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}{CollectionAction}.\hypertarget{classSaveEventsAction_3a59e42181c79dcd192b0be3d14a34c2}{ |
79 |
\index{SaveEventsAction@{SaveEventsAction}!Setup@{Setup}} |
80 |
\index{Setup@{Setup}!SaveEventsAction@{SaveEventsAction}} |
81 |
\subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void SaveEventsAction::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
82 |
\label{classSaveEventsAction_3a59e42181c79dcd192b0be3d14a34c2} |
83 |
|
84 |
|
85 |
The setup procedure. |
86 |
|
87 |
This routine will set the trees to be saved, by calling PamLevel2::SetWhichTrees(). |
88 |
|
89 |
\begin{Desc} |
90 |
\item[Parameters:] |
91 |
\begin{description} |
92 |
\item[{\em events}]The events pointer. \end{description} |
93 |
\end{Desc} |
94 |
|
95 |
|
96 |
Reimplemented from \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{CollectionAction}. |
97 |
|
98 |
The documentation for this class was generated from the following files:\begin{CompactItemize} |
99 |
\item |
100 |
CollectionActions/SaveEventsAction/\hyperlink{SaveEventsAction_8h}{SaveEventsAction.h}\item |
101 |
CollectionActions/SaveEventsAction/\hyperlink{SaveEventsAction_8cpp}{SaveEventsAction.cpp}\end{CompactItemize} |