83cf30b54a07f5c232df099457afa157931910c1
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisManager.h
1 #ifndef ALIANALYSISMANAGER_H
2 #define ALIANALYSISMANAGER_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 //   AliAnalysysManager - Manager analysis class. Allows creation of several
11 // analysis tasks and data containers storing their input/output. Allows 
12 // connecting/chaining tasks via shared data containers. Serializes the current
13 // event for all tasks depending only on initial input data.
14 //==============================================================================
15
16 #ifndef ROOT_TNamed
17 #include <TNamed.h>
18 #endif
19
20 class TClass;
21 class TTree;
22 class AliAnalysisDataContainer;
23 class AliAnalysisTask;
24
25 class AliAnalysisManager : public TNamed {
26
27 public:
28
29 enum EAliAnalysisContType {
30    kExchangeContainer  = 0,
31    kInputContainer   = 1,
32    kOutputContainer  = 2
33 };   
34
35 enum EAliAnalysisExecMode {
36    kLocalAnalysis    = 0,
37    kProofAnalysis    = 1,
38    kGridAnalysis     = 2
39 };
40
41 enum EAliAnalysisFlags {
42    kEventLoop        = BIT(14),
43    kDisableBranches  = BIT(15)
44 };   
45
46    AliAnalysisManager();
47    AliAnalysisManager(const char *name, const char *title="");
48    virtual            ~AliAnalysisManager();
49
50    AliAnalysisManager(const AliAnalysisManager& other);
51    AliAnalysisManager& operator=(const AliAnalysisManager& other);
52    
53    void                StartAnalysis(const char *type="local", TTree *tree=0);
54
55    virtual void        Init(TTree *tree);   
56    virtual void        Begin(TTree *tree);
57    virtual Bool_t      Notify();
58    virtual void        SlaveBegin(TTree *tree);
59    virtual Bool_t      ProcessCut(Long64_t entry) {return Process(entry);}
60    virtual Bool_t      Process(Long64_t entry);
61    virtual Int_t       GetEntry(Long64_t entry, Int_t getall = 0);
62    void                PackOutput(TList *target);
63    void                UnpackOutput(TList *source);
64    virtual void        Terminate();
65
66    // Getters/Setters
67    static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
68    TObjArray          *GetContainers() const {return fContainers;}
69    UInt_t              GetDebugLevel() const {return fDebug;}
70    TObjArray          *GetInputs() const     {return fInputs;}
71    TObjArray          *GetOutputs() const    {return fOutputs;}
72    TObjArray          *GetTasks() const      {return fTasks;}
73    TObjArray          *GetTopTasks() const   {return fTopTasks;}
74    TTree              *GetTree() const       {return fTree;}
75    TObjArray          *GetZombieTasks() const {return fZombies;}
76    Long64_t            GetCurrentEntry() const {return fCurrentEntry;}
77    EAliAnalysisExecMode 
78                        GetAnalysisType() const {return fMode;}
79
80    void                SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
81    void                SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
82    void                SetDebugLevel(UInt_t level) {fDebug = level;}
83    void                SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);}
84
85    // Container handling
86    AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype, 
87                        EAliAnalysisContType type     = kExchangeContainer, 
88                        const char          *filename = NULL);
89    
90    // Including tasks and getting them
91    void                 AddTask(AliAnalysisTask *task);
92    AliAnalysisTask     *GetTask(const char *name) const;
93    
94    // Connecting data containers to task inputs/outputs
95    Bool_t               ConnectInput(AliAnalysisTask *task, Int_t islot,
96                                      AliAnalysisDataContainer *cont);
97    Bool_t               ConnectOutput(AliAnalysisTask *task, Int_t islot,
98                                      AliAnalysisDataContainer *cont);
99    // Garbage collection
100    void                 CleanContainers();
101    
102    // Analysis initialization and execution, status
103    Bool_t               InitAnalysis();
104    Bool_t               IsInitialized() const {return fInitOK;}
105    Bool_t               IsEventLoop() const {return TObject::TestBit(kEventLoop);}
106    void                 ResetAnalysis();
107    void                 ExecAnalysis(Option_t *option="");
108    void                 FinishAnalysis();
109    void                 PrintStatus(Option_t *option="all") const;
110
111 protected:
112    void                 ImportWrappers(TList *source);
113    void                 SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
114
115 private:
116    TTree               *fTree;         //! Input tree in case of TSelector model
117    Long64_t             fCurrentEntry; //! Current processed entry in the tree
118    EAliAnalysisExecMode fMode;         // Execution mode
119    Bool_t               fInitOK;       // Initialisation done
120    UInt_t               fDebug;        // Debug level
121    TObjArray           *fTasks;        // List of analysis tasks
122    TObjArray           *fTopTasks;     // List of top tasks
123    TObjArray           *fZombies;      // List of zombie tasks
124    TObjArray           *fContainers;   // List of all containers
125    TObjArray           *fInputs;       // List of containers with input data
126    TObjArray           *fOutputs;      // List of containers with results
127
128    static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
129    ClassDef(AliAnalysisManager,1)  // Analysis manager class
130 };   
131 #endif