- Optional AliAnalysisTask::Cleanup() method added. To be overwritten by user task
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisTask.h
1 #ifndef ALIANALYSISTASK_H
2 #define ALIANALYSISTASK_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /* $Id$ */
7 // Author: Andrei Gheata, 31/05/2006
8
9 //==============================================================================
10 //   AliAnalysysTask - Class representing a basic analysis task. Any
11 // user-defined task should derive from it and implement the Exec() virtual
12 // method.
13 //==============================================================================
14
15 #ifndef ROOT_TTask
16 #include "TTask.h"
17 #endif
18
19 #ifndef ROOT_TObjArray
20 #include "TObjArray.h"
21 #endif
22
23 class TClass;
24 class TFile;
25 class AliAnalysisDataSlot;
26 class AliAnalysisDataContainer;
27
28 class AliAnalysisTask : public TTask {
29  public:
30   enum EAnalysisTaskFlags {
31     kTaskUsed    = BIT(14),
32     kTaskZombie  = BIT(15),
33     kTaskChecked = BIT(16),
34     kTaskPostEventLoop = BIT(17)
35   };
36
37  protected:
38   Bool_t                    fReady;         // Flag if the task is ready
39   Bool_t                    fInitialized;   // True if Init() was called
40   Int_t                     fNinputs;       // Number of inputs
41   Int_t                     fNoutputs;      // Number of outputs
42   Bool_t                   *fOutputReady;   //[fNoutputs] Flags for output readyness
43   TObject                  *fPublishedData; //! published data
44   TObjArray                *fInputs;        // Array of input slots
45   TObjArray                *fOutputs;       // Array of output slots
46
47   // Define the input/output slots (called by user in the ctor of the derived class)
48   //=== CALL IN THE CONSTRUCTOR OF DERIVED CLASS TO DEFINE INPUTS/OUTPUTS ===
49   void                      DefineInput(Int_t islot, TClass *type);
50   void                      DefineOutput(Int_t islot, TClass *type);
51   
52   //=====================================================================
53   // === OVERLOAD THIS TO CONNECT TREE BRANCHES AT INPUT SLOTS. YOU
54   // SHOULD DEFINE HERE ALSO THE OBJECTS TO BE CONNECTED TO YOUR OUTPUTS
55   virtual void              ConnectInputData(Option_t *option="");
56   //=====================================================================
57   
58   // Post output data (called by Exec() when data is ready)
59   //=== CALL IN EXEC() FOR EACH OUTPUT WHEN READY ===
60   Bool_t                    PostData(Int_t iout, TObject *data, Option_t *option="");
61   //=====================================================================
62   
63   // === USE THIS FIRST IN YOUR ConnectInputData() TO CHECH IF A BRANCH IS ALREADY CONNECTED
64   // TO SOME ADDRESS.
65   char                     *GetBranchAddress(Int_t islot, const char *branch) const;
66   // === CALL THIS AFTERWARDS IN ConnectInputData() IF THE BRANCH ADDRESS IS NOT YET SET
67   Bool_t                    SetBranchAddress(Int_t islot, const char *branch, void *address) const;
68   //=====================================================================
69   //=== CALL IN ConnectInputData() TO ENABLE ONLY EXPLICIT BRANCHES NEEDED FOR THIS TASK EXECUTION
70   void                      EnableBranch(Int_t islot, const char *bname) const;
71   //=====================================================================
72   // === CALL THIS IN CreateOutputObjects BEFORE CREATING THE OBJECT FOR EACH 
73   // OUTPUT IOUT THAT HAS TO BE WRITTEN TO A FILE
74   TFile                    *OpenFile(Int_t iout, Option_t *option="RECREATE") const;
75   
76 public:  
77   AliAnalysisTask();
78   AliAnalysisTask(const char *name, const char *title);
79   AliAnalysisTask(const AliAnalysisTask &task); 
80   virtual ~AliAnalysisTask();
81   
82   // Assignment
83   AliAnalysisTask& operator=(const AliAnalysisTask &task);
84   //=====================================================================
85   // === OVERLOAD THIS AND CREATE YOUR OUTPUT OBJECTS (HISTOGRAMS,DATA) HERE
86   virtual void              CreateOutputObjects();
87   // === OVERLOAD THIS IF YOU NEED TO INITIALIZE YOUR CLASS ON THE CLIENT
88   virtual void              LocalInit();
89   // === OVERLOAD THIS IF YOU NEED TO TREAT INPUT FILE/TREE CHANGE
90   virtual Bool_t            Notify();
91   //=====================================================================
92   // Optional cleanup method to be called only in PROOF in SlaveTerminate phase
93   virtual void              Cleanup();
94   // Conect inputs/outputs to data containers (by AliAnalysisModule)
95   Bool_t                    ConnectInput(Int_t islot, AliAnalysisDataContainer *cont);
96   Bool_t                    ConnectOutput(Int_t islot, AliAnalysisDataContainer *cont);
97   // Check connectivity
98   Bool_t                    AreSlotsConnected();
99   // Check if data for all inputs is ready
100   void                      CheckNotify(Bool_t init=kFALSE);
101   // Check if there are illegal circular dependencies
102   Bool_t                    CheckCircularDeps();
103   // Getters
104   Int_t                     GetNinputs() const  {return fNinputs;}
105   Int_t                     GetNoutputs() const {return fNoutputs;}
106   TObject                  *GetPublishedData() const {return fPublishedData;}
107   AliAnalysisDataSlot      *GetInputSlot(Int_t islot) const  {return (AliAnalysisDataSlot*)fInputs->At(islot);}
108   AliAnalysisDataSlot      *GetOutputSlot(Int_t islot) const {return (AliAnalysisDataSlot*)fOutputs->At(islot);}
109   TClass                   *GetInputType(Int_t islot) const;
110   TClass                   *GetOutputType(Int_t islot) const;
111   // === USE THIS TO RETREIVE INPUT DATA AND STATICALLY CAST IT TO THE DECLARED TYPE
112   TObject                  *GetInputData(Int_t islot) const;
113   TObject                  *GetOutputData(Int_t islot) const;  
114   Bool_t                    IsOutputReady(Int_t islot) const {return fOutputReady[islot];}
115   Bool_t                    IsChecked() const  {return TObject::TestBit(kTaskChecked);}
116   Bool_t                    IsPostEventLoop() const {return TObject::TestBit(kTaskPostEventLoop);}
117   Bool_t                    IsInitialized() const  {return fInitialized;}
118   Bool_t                    IsReady() const  {return fReady;}
119   Bool_t                    IsUsed() const   {return TObject::TestBit(kTaskUsed);}
120   Bool_t                    IsZombie() const {return TObject::TestBit(kTaskZombie);}
121   void                      PrintTask(Option_t *option="all", Int_t indent=0) const;
122   void                      PrintContainers(Option_t *option="all", Int_t indent=0) const;
123   void                      SetChecked(Bool_t flag=kTRUE) {TObject::SetBit(kTaskChecked,flag);}
124   void                      SetPostEventLoop(Bool_t flag=kTRUE);
125   void                      SetUsed(Bool_t flag=kTRUE);
126   void                      SetZombie(Bool_t flag=kTRUE) {TObject::SetBit(kTaskZombie,flag);}
127   // Main task execution 
128   //=== IMPLEMENT THIS !!! ==============================================
129   virtual void              Exec(Option_t *option) = 0;
130   //=====================================================================
131   Bool_t                    HasExecuted() const {return fHasExecuted;}
132   //=====================================================================
133   // === OVERLOAD THIS IF YOU WANT TO DO SOMETHING WITH THE OUTPUT
134   virtual void              Terminate(Option_t *option="");
135   //=====================================================================
136     
137   ClassDef(AliAnalysisTask,1)  // Class describing an analysis task
138 };
139 #endif