--- PamCut/CollectionActions/TreeOutputActions/TreeOutputAction/TreeOutputAction.h 2009/11/13 16:37:12 1.1 +++ PamCut/CollectionActions/TreeOutputActions/TreeOutputAction/TreeOutputAction.h 2010/03/23 17:27:43 1.2 @@ -18,7 +18,8 @@ * It takes care of opening the file, filling the tree and writing it on a file. Descendants * have to implement the pure virtual members #_InitBranches() and #_ComputeBranches, which * takes care, for the current event, of creating the branches and filling the structures - * linked to the branches. + * linked to the branches. #_InitBranches() will be automatically called at the beginning of + * the analysis, while #_ComputeBranches will be invoked for each event. */ class TreeOutputAction: public CollectionAction { @@ -40,6 +41,8 @@ /*! @brief The pre-selection tasks. * * This routine opens the ROOT output file and calls the #_InitBranches() method. + * + * @param events Pointer to PamLevel2 object which contains the events to analize. */ void Setup(PamLevel2 *events); @@ -74,8 +77,10 @@ * Concrete implementations of this method will have to set the branches to save in * the file. The tree object which has to be branched is #_tree. If one wants to * branch his own structure, one possibility is to define it in the child class' header. + * + * @param events Pointer to PamLevel2 object which contains the events to analize. */ - virtual void _InitBranches(PamLevel2 *event) = 0; + virtual void _InitBranches(PamLevel2 *events) = 0; /*! @brief The branch computation routine. * @@ -83,6 +88,8 @@ * event's data. Remember to NOT call _tree.Fill() here: this operation is automatically * handled by #OnGood(), so you have only to care about filling the buffers. * Implementation is demanded to concrete children classes. + * + * @param event The selected event. */ virtual void _ComputeBranches(PamLevel2 *event) = 0;