/[PAMELA software]/PamCut/Collections/SmartCollection/SmartCollection.h
ViewVC logotype

Diff of /PamCut/Collections/SmartCollection/SmartCollection.h

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

revision 1.2 by pam-fi, Fri May 29 10:10:31 2009 UTC revision 1.6 by pam-fi, Fri Aug 14 10:31:48 2009 UTC
# Line 15  Line 15 
15    
16  /*! @brief A collection class designed to use CollectionAction objects.  /*! @brief A collection class designed to use CollectionAction objects.
17   *   *
18   * The SmartCollection class is designed to handle CollectionAction objects. These   * The SmartCollection class is designed to handle CollectionAction objects. It
19   * defines the procedures to do when an event is selected or discarded. A SmartCollection   * holds a vector of these objects and takes care of calling Setup and Finalize for
20   * handles a vector of these objects, calling CollectionAction::OnGood() for each of them   * each of them at the beginning and at the end of the analysis, respectively.
21   * when a good event is selected and CollectionAction::OnBad() when a bad one is rejected.   * Actions can be added to the SmartCollection by means of the AddAction() method.
22   * It will also call the CollectionAction::Setup() and CollectionAction::Finalize() methods   * If a bunch of cuts have been already added to the collection, the action will
23   * at the beginning and at the end of the analysis, respectively.   * be logically placed after the cuts. The SmartCollection will call
24     * CollectionAction::OnGood() if the cuts preceding the actions are satisfied, and
25     * CollectionAction::OnBad() if at least one of them fails. An action will not be
26     * sensitive to cuts added to the collection after the action itself.
27     * The resulting structure is composed by bunches of cuts intertwined by actions,
28     * which are "executed" depending on the result of the bunch of cuts that precedes the
29     * action. Note that CollectionAction::OnBad() is called only for those actions at
30     * the end of the bunch where the first failed cut is: if after these actions there
31     * are other bunches of cuts and actions, they will be ignored.
32     * For example, in the sequence below:
33   *   *
34     * | cut1 | cut2 | action1 | action2 | cut3 | cut4 | action3 | ...
35     *
36     * action1 and action2 are executed (eg., OnGood is called for them) if cut1 and cut2
37     * are both satisfied, then cut3 and cut4 are evaluated and if both of them are satisfied
38     * then action3 is executed. If, for example, cut 1 or cut2 fail, then OnBad is called for
39     * action1 and action2; however, cut3, cut4, action3 and all that follows are ignored. The
40     * analysis goes on with the next event.
41   */   */
42  class SmartCollection: public PamCutCollection {  class SmartCollection: public PamCutCollection {
43    
# Line 50  public: Line 66  public:
66     */     */
67    CollectionAction *GetAction(unsigned int iAction);    CollectionAction *GetAction(unsigned int iAction);
68    
69      /*! @brief Searches for an action by name.
70       *
71       * @param actionName The name of the action to search for.
72       * @return pointer to the desired action; NULL if the specified action cannot be found or if no actions are present.
73       */
74      CollectionAction *GetAction(const char *actionName);
75    
76      /*! @brief The number of actions in the collection.
77       *
78       * @return The number of actions currently in the collection.
79       */
80      unsigned int GetActionsSize(){
81        return _actions.size();
82      }
83    
84    /*! @brief The pre-analysis task definition.    /*! @brief The pre-analysis task definition.
85     *     *
86     * This override of the Setup() method calls Setup() for the base class PamCutCollection, and subsequently for each     * This override of the Setup() method calls Setup() for the base class PamCutCollection, and subsequently for each
# Line 67  public: Line 98  public:
98     */     */
99    void Finalize();    void Finalize();
100    
101    /*! @brief Post-selection tasks.    /*! Applies the cuts and executes the actions.
    *  
    * This routine is automatically called after a good event has been selected by  
    * ApplyCut(). It will simply call PamCutCollection::OnGood() and then CollectionAction::OnGood() for each  
    * action in the SmartCollection.  
    * @param event The event which satisfy the cut.  
    */  
   void OnGood(PamLevel2 *event);  
   
   /*! @brief Post-selection tasks.  
102     *     *
103     * This routine is automatically called after a bad event has been rejected by     * When cuts are applied, a SmartCollection will also execute the actions at the end of the bunches of cuts.
    * ApplyCut(). It will simply call PamCutCollection::OnBad() and then CollectionAction::OnBad() for each  
    * action in the SmartCollection.  
104     *     *
105     * @see OnGood     * @param event The event to analyze.
    * @param event The event which don't satisfy the cut.  
    * @param selectionResult The return value of the Check() routine.  
106     */     */
107    void OnBad(PamLevel2 *event, int selectionResult);    int ApplyCut(PamLevel2 *event);
108    
109  private:  protected:
110    
111      /*! @brief The vector containing the actions */
112    std::vector<CollectionAction*> _actions;    std::vector<CollectionAction*> _actions;
113    
114      /*! The vector of actions' positions
115       *
116       * An action is placed after N cuts, so that the SmartCollection, after applying N cuts, has to
117       * perform the action. The numbers N for each action are stored here: the element i is N for the
118       * i-th action in #_actions.
119       */
120      std::vector<unsigned int> _actionsPositions;
121    
122  };  };
123    
124  #endif /* SMARTCOLLECTION_H_ */  #endif /* SMARTCOLLECTION_H_ */
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.6
  ViewVC Help
Powered by ViewVC 1.1.23