ANALYSIS/AliAnalysisDataContainer.h

   1 #ifndef ALIANALYSISDATACONTAINER_H
   2 #define ALIANALYSISDATACONTAINER_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 //   AliAnalysysDataContainer - Container of data of arbitrary type deriving
  11 //      from TObject used for analysis. A container must be connected to the
  12 //      output data slot of a single analysis task (producer) , but also as
  13 //      input slot for possibly several other tasks (consumers). The connected
  14 //      slots must enforce the same data type as the container (or a derived type).
  15 //      A container becomes the owner of the contained data once this was produced.
  16 //==============================================================================
  17
  18 #ifndef ROOT_TNamed
  19 #include "TNamed.h"
  20 #endif
  21
  22 #ifndef ROOT_TString
  23 #include "TString.h"
  24 #endif
  25
  26 class TClass;
  27 class TFile;
  28 class TObjArray;
  29 class TCollection;
  30 class AliAnalysisTask;
  31 class AliAnalysisDataWrapper;
  32
  33 class AliAnalysisDataContainer : public TNamed {
  34
  35 public:
  36 enum ENotifyMessage {
  37    kDeleteData,
  38    kSaveData,
  39    kFileChange
  40 };
  41 enum EAnalysisContainerFlags {
  42    kPostEventLoop = BIT(14),
  43    kSpecialOutput = BIT(15)
  44 };
  45    AliAnalysisDataContainer();
  46    AliAnalysisDataContainer(const AliAnalysisDataContainer &cont);
  47    AliAnalysisDataContainer(const char *name, TClass *type);
  48    virtual ~AliAnalysisDataContainer();
  49
  50    // Assignment
  51    AliAnalysisDataContainer &operator=(const AliAnalysisDataContainer &cont);
  52    // Getters
  53    TObject                  *GetData() const      {return fData;}
  54    const char               *GetFileName() const  {return fFileName.Data();}
  55    const char               *GetFolderName() const {return fFolderName.Data();}
  56    TFile                    *GetFile() const      {return fFile;}
  57    TClass                   *GetType() const;
  58    AliAnalysisTask          *GetProducer() const  {return fProducer;}
  59    TObjArray                *GetConsumers() const {return fConsumers;}
  60    virtual void              GetEntry(Long64_t ientry);
  61    // Setters
  62    void                      ResetDataReady()     {fDataReady = kFALSE;}
  63    virtual Bool_t            SetData(TObject *data, Option_t *option="");
  64    void                      SetDataOwned(Bool_t flag) {fOwnedData = flag;}
  65    void                      SetPostEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kPostEventLoop,flag);}
  66    void                      SetSpecialOutput(Bool_t flag=kTRUE) {TObject::SetBit(kSpecialOutput,flag);}
  67    void                      SetFileName(const char *filename);
  68    void                      SetFile(TFile *f) {fFile = f;}
  69    void                      SetProducer(AliAnalysisTask *prod, Int_t islot);
  70    void                      AddConsumer(AliAnalysisTask *cons, Int_t islot);
  71    void                      DeleteData();
  72    // Wrapping
  73    AliAnalysisDataWrapper   *ExportData() const;
  74    void                      ImportData(AliAnalysisDataWrapper *pack);
  75    // Container status checking
  76    Bool_t                    IsDataReady() const  {return fDataReady;}
  77    Bool_t                    IsPostEventLoop() const {return TObject::TestBit(kPostEventLoop);}
  78    Bool_t                    IsSpecialOutput() const {return TObject::TestBit(kSpecialOutput);}
  79    Bool_t                    IsOwnedData() const  {return fOwnedData;}
  80    Bool_t                    ClientsExecuted() const;
  81    Bool_t                    HasConsumers() const {return (fConsumers != 0);}
  82    Bool_t                    HasProducer() const  {return (fProducer != 0);}
  83    // Container merging
  84    virtual Long64_t          Merge(TCollection *list);
  85    // Send a notify signal to the container
  86    virtual void              NotifyChange(ENotifyMessage /*type*/) {;}
  87    // Print connected tasks/status
  88    void                      PrintContainer(Option_t *option="all", Int_t indent=0) const;
  89
  90 private:
  91    void                      SetType(TClass *type) {fType = type;}
  92
  93 protected:
  94    Bool_t                    fDataReady;  // Flag that data is ready
  95    Bool_t                    fOwnedData;  // Flag data ownership
  96    TString                   fFileName;   // File storing the data
  97    TString                   fFolderName; // Folder name in the output file
  98    TFile                    *fFile;       //! Opened file
  99    TObject                  *fData;       // Contained data
 100    TClass                   *fType;       //! Type of contained data
 101    AliAnalysisTask          *fProducer;   // Analysis task to which the slot belongs
 102    TObjArray                *fConsumers;  // List of consumers of the data
 103
 104    ClassDef(AliAnalysisDataContainer,2)  // Class describing a data container for analysis
 105 };
 106
 107 //==============================================================================
 108 //   AliAnalysysDataWrapper - A basic wrapper for exchanging via the network
 109 // the data held by AliAnalysisDataContainer between the master and the client
 110 // in PROOF case.
 111 //==============================================================================
 112
 113 class AliAnalysisDataWrapper : public TNamed {
 114
 115 public:
 116
 117 enum EAnalysisWrapperFlags {
 118    kDeleteData = BIT(14)
 119 };
 120    AliAnalysisDataWrapper() : TNamed(), fData(NULL) {}
 121    AliAnalysisDataWrapper(TObject *data);
 122    AliAnalysisDataWrapper(const AliAnalysisDataWrapper &other)
 123                         : TNamed(other), fData(other.fData) {}
 124    virtual ~AliAnalysisDataWrapper();
 125
 126    // Assignment
 127    AliAnalysisDataWrapper &operator=(const AliAnalysisDataWrapper &other);
 128
 129    TObject                  *Data() const {return fData;}
 130    // Merging
 131    virtual Long64_t          Merge(TCollection *list);
 132    void                      SetDeleteData(Bool_t flag=kTRUE) {TObject::SetBit(kDeleteData,flag);}
 133
 134 protected:
 135    TObject                  *fData;       // Wrapped data
 136
 137    ClassDef(AliAnalysisDataWrapper, 1) // Data wrapper class for exchange via the net
 138 };
 139
 140 #endif