| 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 |
\hyperlink{classSaveEventsAction_08ebe8957cdc27c39a622779b0114440}{$\sim$SaveEventsAction} () |
| 22 |
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item |
| 23 |
void \hyperlink{classSaveEventsAction_3a59e42181c79dcd192b0be3d14a34c2}{Setup} (PamLevel2 $\ast$events) |
| 24 |
\begin{CompactList}\small\item\em The setup procedure. \item\end{CompactList}\item |
| 25 |
void \hyperlink{classSaveEventsAction_47e8259afe7a68ba3c0adf3bd79fe52a}{OnGood} (PamLevel2 $\ast$event) |
| 26 |
\begin{CompactList}\small\item\em Fills the tree with the selected event. \item\end{CompactList}\item |
| 27 |
void \hyperlink{classSaveEventsAction_790f534c0a888c2a57814cd859b97270}{Finalize} () |
| 28 |
\begin{CompactList}\small\item\em Writes the tree of saved events to the output file. \item\end{CompactList}\end{CompactItemize} |
| 29 |
\subsection*{Private Attributes} |
| 30 |
\begin{CompactItemize} |
| 31 |
\item |
| 32 |
TFile $\ast$ \hyperlink{classSaveEventsAction_955b11224d55598002d469b07632551f}{\_\-outTreeFile} |
| 33 |
\item |
| 34 |
PamLevel2 $\ast$ \hyperlink{classSaveEventsAction_3e30ca3f79e10b745b10026ce4dcaddc}{\_\-events} |
| 35 |
\item |
| 36 |
TString \hyperlink{classSaveEventsAction_0c1166571d97d354708f7c3fbe62d1f9}{\_\-outOptions} |
| 37 |
\end{CompactItemize} |
| 38 |
|
| 39 |
|
| 40 |
\subsection{Detailed Description} |
| 41 |
An action that saves the selected events. |
| 42 |
|
| 43 |
This action saves the selected events into a ROOT file. |
| 44 |
|
| 45 |
Definition at line 19 of file SaveEventsAction.h. |
| 46 |
|
| 47 |
\subsection{Constructor \& Destructor Documentation} |
| 48 |
\hypertarget{classSaveEventsAction_c758fdbf708778a0c0497bb65fefa75a}{ |
| 49 |
\index{SaveEventsAction@{SaveEventsAction}!SaveEventsAction@{SaveEventsAction}} |
| 50 |
\index{SaveEventsAction@{SaveEventsAction}!SaveEventsAction@{SaveEventsAction}} |
| 51 |
\subsubsection[{SaveEventsAction}]{\setlength{\rightskip}{0pt plus 5cm}SaveEventsAction::SaveEventsAction (const char $\ast$ {\em actionName}, \/ TString {\em outFileName}, \/ TString {\em outOptions} = {\tt TString(\char`\"{}\char`\"{})})}} |
| 52 |
\label{classSaveEventsAction_c758fdbf708778a0c0497bb65fefa75a} |
| 53 |
|
| 54 |
|
| 55 |
Constructor. |
| 56 |
|
| 57 |
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. |
| 58 |
|
| 59 |
\begin{Desc} |
| 60 |
\item[Parameters:] |
| 61 |
\begin{description} |
| 62 |
\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} |
| 63 |
\end{Desc} |
| 64 |
|
| 65 |
|
| 66 |
Definition at line 12 of file SaveEventsAction.cpp. |
| 67 |
|
| 68 |
References \_\-outTreeFile.\hypertarget{classSaveEventsAction_08ebe8957cdc27c39a622779b0114440}{ |
| 69 |
\index{SaveEventsAction@{SaveEventsAction}!$\sim$SaveEventsAction@{$\sim$SaveEventsAction}} |
| 70 |
\index{$\sim$SaveEventsAction@{$\sim$SaveEventsAction}!SaveEventsAction@{SaveEventsAction}} |
| 71 |
\subsubsection[{$\sim$SaveEventsAction}]{\setlength{\rightskip}{0pt plus 5cm}SaveEventsAction::$\sim$SaveEventsAction ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 72 |
\label{classSaveEventsAction_08ebe8957cdc27c39a622779b0114440} |
| 73 |
|
| 74 |
|
| 75 |
Destructor. |
| 76 |
|
| 77 |
|
| 78 |
|
| 79 |
Definition at line 34 of file SaveEventsAction.h. |
| 80 |
|
| 81 |
\subsection{Member Function Documentation} |
| 82 |
\hypertarget{classSaveEventsAction_790f534c0a888c2a57814cd859b97270}{ |
| 83 |
\index{SaveEventsAction@{SaveEventsAction}!Finalize@{Finalize}} |
| 84 |
\index{Finalize@{Finalize}!SaveEventsAction@{SaveEventsAction}} |
| 85 |
\subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void SaveEventsAction::Finalize ()\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 86 |
\label{classSaveEventsAction_790f534c0a888c2a57814cd859b97270} |
| 87 |
|
| 88 |
|
| 89 |
Writes the tree of saved events to the output file. |
| 90 |
|
| 91 |
|
| 92 |
|
| 93 |
Implements \hyperlink{classCollectionAction_c32b42fc08bc1be7b003579b633de041}{CollectionAction}. |
| 94 |
|
| 95 |
Definition at line 43 of file SaveEventsAction.cpp. |
| 96 |
|
| 97 |
References \_\-events, and \_\-outTreeFile.\hypertarget{classSaveEventsAction_47e8259afe7a68ba3c0adf3bd79fe52a}{ |
| 98 |
\index{SaveEventsAction@{SaveEventsAction}!OnGood@{OnGood}} |
| 99 |
\index{OnGood@{OnGood}!SaveEventsAction@{SaveEventsAction}} |
| 100 |
\subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void SaveEventsAction::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 101 |
\label{classSaveEventsAction_47e8259afe7a68ba3c0adf3bd79fe52a} |
| 102 |
|
| 103 |
|
| 104 |
Fills the tree with the selected event. |
| 105 |
|
| 106 |
\begin{Desc} |
| 107 |
\item[Parameters:] |
| 108 |
\begin{description} |
| 109 |
\item[{\em event}]The selected event. \end{description} |
| 110 |
\end{Desc} |
| 111 |
|
| 112 |
|
| 113 |
Implements \hyperlink{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{CollectionAction}. |
| 114 |
|
| 115 |
Definition at line 38 of file SaveEventsAction.cpp.\hypertarget{classSaveEventsAction_3a59e42181c79dcd192b0be3d14a34c2}{ |
| 116 |
\index{SaveEventsAction@{SaveEventsAction}!Setup@{Setup}} |
| 117 |
\index{Setup@{Setup}!SaveEventsAction@{SaveEventsAction}} |
| 118 |
\subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void SaveEventsAction::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 119 |
\label{classSaveEventsAction_3a59e42181c79dcd192b0be3d14a34c2} |
| 120 |
|
| 121 |
|
| 122 |
The setup procedure. |
| 123 |
|
| 124 |
This routine will set the trees to be saved, by calling PamLevel2::SetWhichTrees(). |
| 125 |
|
| 126 |
\begin{Desc} |
| 127 |
\item[Parameters:] |
| 128 |
\begin{description} |
| 129 |
\item[{\em events}]The events pointer. \end{description} |
| 130 |
\end{Desc} |
| 131 |
|
| 132 |
|
| 133 |
Reimplemented from \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{CollectionAction}. |
| 134 |
|
| 135 |
Definition at line 31 of file SaveEventsAction.cpp. |
| 136 |
|
| 137 |
References \_\-events, \_\-outOptions, and \_\-outTreeFile. |
| 138 |
|
| 139 |
\subsection{Member Data Documentation} |
| 140 |
\hypertarget{classSaveEventsAction_3e30ca3f79e10b745b10026ce4dcaddc}{ |
| 141 |
\index{SaveEventsAction@{SaveEventsAction}!\_\-events@{\_\-events}} |
| 142 |
\index{\_\-events@{\_\-events}!SaveEventsAction@{SaveEventsAction}} |
| 143 |
\subsubsection[{\_\-events}]{\setlength{\rightskip}{0pt plus 5cm}PamLevel2$\ast$ {\bf SaveEventsAction::\_\-events}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
| 144 |
\label{classSaveEventsAction_3e30ca3f79e10b745b10026ce4dcaddc} |
| 145 |
|
| 146 |
|
| 147 |
|
| 148 |
|
| 149 |
Definition at line 57 of file SaveEventsAction.h. |
| 150 |
|
| 151 |
Referenced by Finalize(), and Setup().\hypertarget{classSaveEventsAction_0c1166571d97d354708f7c3fbe62d1f9}{ |
| 152 |
\index{SaveEventsAction@{SaveEventsAction}!\_\-outOptions@{\_\-outOptions}} |
| 153 |
\index{\_\-outOptions@{\_\-outOptions}!SaveEventsAction@{SaveEventsAction}} |
| 154 |
\subsubsection[{\_\-outOptions}]{\setlength{\rightskip}{0pt plus 5cm}TString {\bf SaveEventsAction::\_\-outOptions}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
| 155 |
\label{classSaveEventsAction_0c1166571d97d354708f7c3fbe62d1f9} |
| 156 |
|
| 157 |
|
| 158 |
|
| 159 |
|
| 160 |
Definition at line 58 of file SaveEventsAction.h. |
| 161 |
|
| 162 |
Referenced by Setup().\hypertarget{classSaveEventsAction_955b11224d55598002d469b07632551f}{ |
| 163 |
\index{SaveEventsAction@{SaveEventsAction}!\_\-outTreeFile@{\_\-outTreeFile}} |
| 164 |
\index{\_\-outTreeFile@{\_\-outTreeFile}!SaveEventsAction@{SaveEventsAction}} |
| 165 |
\subsubsection[{\_\-outTreeFile}]{\setlength{\rightskip}{0pt plus 5cm}TFile$\ast$ {\bf SaveEventsAction::\_\-outTreeFile}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
| 166 |
\label{classSaveEventsAction_955b11224d55598002d469b07632551f} |
| 167 |
|
| 168 |
|
| 169 |
|
| 170 |
|
| 171 |
Definition at line 56 of file SaveEventsAction.h. |
| 172 |
|
| 173 |
Referenced by Finalize(), SaveEventsAction(), and Setup(). |
| 174 |
|
| 175 |
The documentation for this class was generated from the following files:\begin{CompactItemize} |
| 176 |
\item |
| 177 |
CollectionActions/SaveEventsAction/\hyperlink{SaveEventsAction_8h}{SaveEventsAction.h}\item |
| 178 |
CollectionActions/SaveEventsAction/\hyperlink{SaveEventsAction_8cpp}{SaveEventsAction.cpp}\end{CompactItemize} |
Parent Directory
| 
Revision Log