Fix plus small changes
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisTask.h
index 35bfd1b..cc3b89b 100644 (file)
@@ -21,6 +21,7 @@
 #endif
 
 class TClass;
+class TFile;
 class AliAnalysisDataSlot;
 class AliAnalysisDataContainer;
 
@@ -29,24 +30,25 @@ class AliAnalysisTask : public TTask {
   enum EAnalysisTaskFlags {
     kTaskUsed    = BIT(14),
     kTaskZombie  = BIT(15),
-    kTaskChecked = BIT(16)
-  };   
+    kTaskChecked = BIT(16),
+    kTaskPostEventLoop = BIT(17)
+  };
 
  protected:
-  Bool_t                    fReady;      // Flag if the task is ready
-  Bool_t                    fInitialized; // True if Init() was called
-  Int_t                     fNinputs;    // Number of inputs
-  Int_t                     fNoutputs;   // Number of outputs
-  Bool_t                   *fOutputReady; //[fNoutputs] Flags for output readyness
-  TObject                  *fPublishedData; // !published data
-  TObjArray                *fInputs;     // Array of input slots
-  TObjArray                *fOutputs;    // Array of output slots
+  Bool_t                    fReady;         // Flag if the task is ready
+  Bool_t                    fInitialized;   // True if Init() was called
+  Int_t                     fNinputs;       // Number of inputs
+  Int_t                     fNoutputs;      // Number of outputs
+  Bool_t                   *fOutputReady;   //[fNoutputs] Flags for output readyness
+  TObject                  *fPublishedData; //! published data
+  TObjArray                *fInputs;        // Array of input slots
+  TObjArray                *fOutputs;       // Array of output slots
+  TString                   fBranchNames;   // List of input branches that need to be loaded for this task
 
   // Define the input/output slots (called by user in the ctor of the derived class)
   //=== CALL IN THE CONSTRUCTOR OF DERIVED CLASS TO DEFINE INPUTS/OUTPUTS ===
   void                      DefineInput(Int_t islot, TClass *type);
   void                      DefineOutput(Int_t islot, TClass *type);
-  //=====================================================================
   
   //=====================================================================
   // === OVERLOAD THIS TO CONNECT TREE BRANCHES AT INPUT SLOTS. YOU
@@ -59,14 +61,18 @@ class AliAnalysisTask : public TTask {
   Bool_t                    PostData(Int_t iout, TObject *data, Option_t *option="");
   //=====================================================================
   
-  // === USE THIS FIRST IN YOUR Init() TO CHECH IF A BRANCH IS ALREADY CONNECTED
+  // === USE THIS FIRST IN YOUR ConnectInputData() TO CHECH IF A BRANCH IS ALREADY CONNECTED
   // TO SOME ADDRESS.
   char                     *GetBranchAddress(Int_t islot, const char *branch) const;
-  // === CALL THIS AFTERWARDS IN Init() IF THE BRANCH ADDRESS IS NOT YET SET
+  // === CALL THIS AFTERWARDS IN ConnectInputData() IF THE BRANCH ADDRESS IS NOT YET SET
   Bool_t                    SetBranchAddress(Int_t islot, const char *branch, void *address) const;
   //=====================================================================
-  // === CALL THIS IN CreateOutputObjects IF THE OUTPUT IS TO BE WRITTEN AT OUTPUT IOUT
-//  void                      OpenFile(Int_t iout, const char *name, Option_t *option) const;
+  //=== CALL IN ConnectInputData() TO ENABLE ONLY EXPLICIT BRANCHES NEEDED FOR THIS TASK EXECUTION
+  void                      EnableBranch(Int_t islot, const char *bname) const;
+  //=====================================================================
+  // === CALL THIS IN CreateOutputObjects BEFORE CREATING THE OBJECT FOR EACH 
+  // OUTPUT IOUT THAT HAS TO BE WRITTEN TO A FILE
+  TFile                    *OpenFile(Int_t iout, Option_t *option="RECREATE") const;
   
 public:  
   AliAnalysisTask();
@@ -79,6 +85,17 @@ public:
   //=====================================================================
   // === OVERLOAD THIS AND CREATE YOUR OUTPUT OBJECTS (HISTOGRAMS,DATA) HERE
   virtual void              CreateOutputObjects();
+  // === OVERLOAD THIS IF YOU NEED TO INITIALIZE YOUR CLASS ON THE CLIENT
+  virtual void              LocalInit();
+  // === OVERLOAD THIS IF YOU NEED TO TREAT INPUT FILE/TREE CHANGE
+  virtual Bool_t            Notify();
+  // === OVERLOAD THIS IF YOU NEED TO TREAT BIN CHANGE IN EVENT MIXING
+  virtual Bool_t            NotifyBinChange();
+  //=====================================================================
+  // Optional method that will be called in SlaveTerminate phase for each task
+  // Warning: in PROOF mode this is called before merging so their cleanup is
+  //          not allowed - do output cleanup in class destructor.
+  virtual void              FinishTaskOutput();
   // Conect inputs/outputs to data containers (by AliAnalysisModule)
   Bool_t                    ConnectInput(Int_t islot, AliAnalysisDataContainer *cont);
   Bool_t                    ConnectOutput(Int_t islot, AliAnalysisDataContainer *cont);
@@ -88,7 +105,10 @@ public:
   void                      CheckNotify(Bool_t init=kFALSE);
   // Check if there are illegal circular dependencies
   Bool_t                    CheckCircularDeps();
+  virtual Bool_t            CheckPostData() const;
+  virtual Bool_t            CheckOwnership() const;
   // Getters
+  void                      GetBranches(const char *type, TString &result) const;
   Int_t                     GetNinputs() const  {return fNinputs;}
   Int_t                     GetNoutputs() const {return fNoutputs;}
   TObject                  *GetPublishedData() const {return fPublishedData;}
@@ -101,13 +121,17 @@ public:
   TObject                  *GetOutputData(Int_t islot) const;  
   Bool_t                    IsOutputReady(Int_t islot) const {return fOutputReady[islot];}
   Bool_t                    IsChecked() const  {return TObject::TestBit(kTaskChecked);}
+  Bool_t                    IsPostEventLoop() const {return TObject::TestBit(kTaskPostEventLoop);}
   Bool_t                    IsInitialized() const  {return fInitialized;}
   Bool_t                    IsReady() const  {return fReady;}
   Bool_t                    IsUsed() const   {return TObject::TestBit(kTaskUsed);}
   Bool_t                    IsZombie() const {return TObject::TestBit(kTaskZombie);}
-  void                      PrintTask(Option_t *option="all", Int_t indent=0) const;
+  Bool_t                    HasBranches() const {return !fBranchNames.IsNull();}
+  virtual void                      PrintTask(Option_t *option="all", Int_t indent=0) const;
   void                      PrintContainers(Option_t *option="all", Int_t indent=0) const;
+  void                      SetBranches(const char *names) {fBranchNames = names;}
   void                      SetChecked(Bool_t flag=kTRUE) {TObject::SetBit(kTaskChecked,flag);}
+  void                      SetPostEventLoop(Bool_t flag=kTRUE);
   void                      SetUsed(Bool_t flag=kTRUE);
   void                      SetZombie(Bool_t flag=kTRUE) {TObject::SetBit(kTaskZombie,flag);}
   // Main task execution 
@@ -120,6 +144,6 @@ public:
   virtual void              Terminate(Option_t *option="");
   //=====================================================================
     
-  ClassDef(AliAnalysisTask,1)  // Class describing an analysis task
+  ClassDef(AliAnalysisTask,2)  // Class describing an analysis task
 };
 #endif