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    kRegisterDataset = BIT(16)
  45 };
  46    AliAnalysisDataContainer();
  47    AliAnalysisDataContainer(const AliAnalysisDataContainer &cont);
  48    AliAnalysisDataContainer(const char *name, TClass *type);
  49    virtual ~AliAnalysisDataContainer();
  50
  51    // Assignment
  52    AliAnalysisDataContainer &operator=(const AliAnalysisDataContainer &cont);
  53    // Getters
  54    TObject                  *GetData() const      {return fData;}
  55    const char               *GetFileName() const  {return fFileName.Data();}
  56    const char               *GetFolderName() const {return fFolderName.Data();}
  57    TFile                    *GetFile() const      {return fFile;}
  58    TClass                   *GetType() const;
  59    AliAnalysisTask          *GetProducer() const  {return fProducer;}
  60    TObjArray                *GetConsumers() const {return fConsumers;}
  61    virtual void              GetEntry(Long64_t ientry);
  62    // Setters
  63    void                      ResetDataReady()     {fDataReady = kFALSE;}
  64    virtual Bool_t            SetData(TObject *data, Option_t *option="");
  65    void                      SetDataOwned(Bool_t flag) {fOwnedData = flag;}
  66    void                      SetPostEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kPostEventLoop,flag);}
  67    void                      SetSpecialOutput(Bool_t flag=kTRUE) {TObject::SetBit(kSpecialOutput,flag);}
  68    void                      SetRegisterDataset(Bool_t flag=kTRUE) {TObject::SetBit(kRegisterDataset,flag);}
  69    void                      SetFileName(const char *filename);
  70    void                      SetFile(TFile *f) {fFile = f;}
  71    void                      SetProducer(AliAnalysisTask *prod, Int_t islot);
  72    void                      AddConsumer(AliAnalysisTask *cons, Int_t islot);
  73    void                      DeleteData();
  74    // Wrapping
  75    AliAnalysisDataWrapper   *ExportData() const;
  76    void                      ImportData(AliAnalysisDataWrapper *pack);
  77    // Container status checking
  78    Bool_t                    IsDataReady() const  {return fDataReady;}
  79    Bool_t                    IsPostEventLoop() const {return TObject::TestBit(kPostEventLoop);}
  80    Bool_t                    IsSpecialOutput() const {return TObject::TestBit(kSpecialOutput);}
  81    Bool_t                    IsRegisterDataset() const {return TObject::TestBit(kRegisterDataset);}
  82    Bool_t                    IsOwnedData() const  {return fOwnedData;}
  83    Bool_t                    ClientsExecuted() const;
  84    Bool_t                    HasConsumers() const {return (fConsumers != 0);}
  85    Bool_t                    HasProducer() const  {return (fProducer != 0);}
  86    // Container merging
  87    virtual Long64_t          Merge(TCollection *list);
  88    // Send a notify signal to the container
  89    virtual void              NotifyChange(ENotifyMessage /*type*/) {;}
  90    // Print connected tasks/status
  91    void                      PrintContainer(Option_t *option="all", Int_t indent=0) const;
  92
  93 private:
  94    void                      SetType(TClass *type) {fType = type;}
  95
  96 protected:
  97    Bool_t                    fDataReady;  // Flag that data is ready
  98    Bool_t                    fOwnedData;  // Flag data ownership
  99    TString                   fFileName;   // File storing the data
 100    TString                   fFolderName; // Folder name in the output file
 101    TFile                    *fFile;       //! Opened file
 102    TObject                  *fData;       // Contained data
 103    TClass                   *fType;       //! Type of contained data
 104    AliAnalysisTask          *fProducer;   // Analysis task to which the slot belongs
 105    TObjArray                *fConsumers;  // List of consumers of the data
 106
 107    ClassDef(AliAnalysisDataContainer,2)  // Class describing a data container for analysis
 108 };
 109
 110 //==============================================================================
 111 //   AliAnalysysDataWrapper - A basic wrapper for exchanging via the network
 112 // the data held by AliAnalysisDataContainer between the master and the client
 113 // in PROOF case.
 114 //==============================================================================
 115
 116 class AliAnalysisDataWrapper : public TNamed {
 117
 118 public:
 119
 120 enum EAnalysisWrapperFlags {
 121    kDeleteData = BIT(14)
 122 };
 123    AliAnalysisDataWrapper() : TNamed(), fData(NULL) {}
 124    AliAnalysisDataWrapper(TObject *data);
 125    AliAnalysisDataWrapper(const AliAnalysisDataWrapper &other)
 126                         : TNamed(other), fData(other.fData) {}
 127    virtual ~AliAnalysisDataWrapper();
 128
 129    // Assignment
 130    AliAnalysisDataWrapper &operator=(const AliAnalysisDataWrapper &other);
 131
 132    TObject                  *Data() const {return fData;}
 133    // Merging
 134    virtual Long64_t          Merge(TCollection *list);
 135    void                      SetDeleteData(Bool_t flag=kTRUE) {TObject::SetBit(kDeleteData,flag);}
 136
 137 protected:
 138    TObject                  *fData;       // Wrapped data
 139
 140    ClassDef(AliAnalysisDataWrapper, 1) // Data wrapper class for exchange via the net
 141 };
 142
 143 //==============================================================================
 144 //   AliAnalysisFileDescriptor - A simple wrapper for data related to accessing
 145 //      an analysis input file.
 146 //==============================================================================
 147 class TStopwatch;
 148
 149 class AliAnalysisFileDescriptor : public TObject {
 150
 151 public:
 152    AliAnalysisFileDescriptor();
 153    AliAnalysisFileDescriptor(const TFile *file);
 154    AliAnalysisFileDescriptor(const AliAnalysisFileDescriptor &other);
 155    virtual ~AliAnalysisFileDescriptor();
 156
 157    // Assignment
 158    AliAnalysisFileDescriptor &operator=(const AliAnalysisFileDescriptor &other);
 159
 160    void         Done();
 161
 162    const char  *GetGUID() const  {return fGUID;}
 163    Int_t        GetImage() const {return fImage;}
 164    const char  *GetLfn() const   {return fLfn;}
 165    Int_t        GetNreplicas() const {return fNreplicas;}
 166    Long64_t     GetOpenAt() const {return fOpenedAt;}
 167    Double_t     GetOpenTime() const {return fOpenTime;}
 168    const char  *GetPfn() const   {return fPfn;}
 169    Long64_t     GetReadBytes() const {return fReadBytes;}
 170    Long64_t     GetSize() const   {return fSize;}
 171    const char  *GetSE() const     {return fSE;}
 172    Double_t     GetThroughput() const {return fThroughput;}
 173    Double_t     GetProcessingTime() const {return fProcessingTime;}
 174    const char  *GetUrl() const    {return fUrl;}
 175    Bool_t       IsArchive() const {return fIsArchive;}
 176    virtual void Print(Option_t *option="") const;
 177    virtual void SavePrimitive(ostream &out, Option_t *option = "");
 178    void         SetOpenTime(Double_t time) {fOpenTime = time;}
 179
 180
 181 protected:
 182    TString      fLfn;       // logical file name
 183    TString      fGUID;      // GUID
 184    TString      fUrl;       // url for the opened copy
 185    TString      fPfn;       // physical file name
 186    TString      fSE;        // Storage element
 187    Bool_t       fIsArchive; // Archive flag
 188    Int_t        fImage;     // Image number
 189    Int_t        fNreplicas; // Number of replicas
 190    Long64_t     fStartBytes;// Total number of read bytes at start
 191    Long64_t     fReadBytes; // Number of bytes read
 192    Long64_t     fSize;      // Size of the file in bytes
 193    Long64_t     fOpenedAt;  // Absolute value for time when opened
 194    Double_t     fOpenTime;  // Time elapsed to open file
 195    Double_t     fProcessingTime; // Processing
 196    Double_t     fThroughput; // Throughput
 197
 198    ClassDef(AliAnalysisFileDescriptor,1)  // Class describing a a file processed in the analysis
 199 };
 200
 201 #endif