/[PAMELA software]/PamCut/PamCutBase/PamCutBase.h
ViewVC logotype

Diff of /PamCut/PamCutBase/PamCutBase.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by pam-fi, Wed May 27 13:30:09 2009 UTC revision 1.4 by pam-fi, Wed Jun 17 12:58:00 2009 UTC
# Line 119  public: Line 119  public:
119     */     */
120    virtual void Setup(PamLevel2 *events);    virtual void Setup(PamLevel2 *events);
121    
122   /*! @brief The post-analysis task definition.    /*! @brief The post-analysis task definition.
123     *     *
124     * This method is automatically called by Process() after the event selection has been     * This method is automatically called by Process() after the event selection has been
125     * performed; override this in derived classes to perform post-analysis tasks like writing     * performed; override this in derived classes to perform post-analysis tasks like writing
# Line 173  public: Line 173  public:
173    
174    /*! @brief Constructor.    /*! @brief Constructor.
175     *     *
176     * @param cutName The cut's name.     * @param collectionName The collection's name.
177     */     */
178    PamCutCollection(const char *cutName) :    PamCutCollection(const char *collectionName) :
179      PamCut(cutName) {      PamCut(collectionName) {
180    }    }
181    
182    /*! @brief Destructor. */    /*! @brief Destructor. */
# Line 197  public: Line 197  public:
197     *  Like in the mother class, this method performs a basic check on the current event: it calls     *  Like in the mother class, this method performs a basic check on the current event: it calls
198     *  Check() for each cut previously added with AddCut(), exiting if one of them is not satisfied.     *  Check() for each cut previously added with AddCut(), exiting if one of them is not satisfied.
199     *     *
200       *  @param event The event to analyze.
201     *  @return the index of the failed cut (range: [0, \#cuts-1], see AddCut()); #CUTOK if the event     *  @return the index of the failed cut (range: [0, \#cuts-1], see AddCut()); #CUTOK if the event
202     *  satisfies all the cuts.     *  satisfies all the cuts.
203     */     */
# Line 223  public: Line 224  public:
224     * */     * */
225    PamCut *GetCut(unsigned int iCut);    PamCut *GetCut(unsigned int iCut);
226    
227      /*! @brief Searches for a cut by name.
228       *
229       *  The return value of this method is a pointer to a PamCut object; hence, to use the specific method of
230       *  derived cuts it must be cast to the proper cut class.
231       *
232       * @param cutName The name of the cut to search for.
233       *  @return pointer to the iCut-th cut; NULL if the specified cut cannot be found or if no cuts are present.
234       * */
235      PamCut *GetCut(const char *cutName);
236    
237    /*! @brief The number of cuts contained in the collection.    /*! @brief The number of cuts contained in the collection.
238     *     *
239     * @return The number of cuts     * @return The number of cuts
240     */     */
241    unsigned int GetSize();    unsigned int GetSize();
242    
   
243    /*! @brief The pre-analysis task definition.    /*! @brief The pre-analysis task definition.
244     *     *
245     * This override of the Setup() method calls Setup() for the base class PamCut, and subsequently for each cut     * This override of the Setup() method calls Setup() for the base class PamCut, and subsequently for each cut
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.4
  ViewVC Help
Powered by ViewVC 1.1.23