AliAnalysisDataContainer.h

Go to the documentation of this file.

#ifndef ALIANALYSISDATACONTAINER_H
#define ALIANALYSISDATACONTAINER_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */


#ifndef ROOT_TNamed
#include "TNamed.h"
#endif

#ifndef ROOT_TString
#include "TString.h"
#endif

#ifndef ROOT_TStopwatch
#include "TStopwatch.h"
#endif

class TClass;
class TFile;
class TObjArray;
class TCollection;
class AliAnalysisTask;
class AliAnalysisDataWrapper;
class TBuffer;

using std::ostream;

class AliAnalysisDataContainer : public TNamed {

public:
enum ENotifyMessage {
   kDeleteData,
   kSaveData,
   kFileChange
};   
enum EAnalysisContainerFlags {
   kPostEventLoop = BIT(14),
   kSpecialOutput = BIT(15),
   kRegisterDataset = BIT(16),
   kExchangeData  = BIT(17),
   kTouchedFlag   = BIT(18)
};     
   AliAnalysisDataContainer();
   AliAnalysisDataContainer(const AliAnalysisDataContainer &cont);
   AliAnalysisDataContainer(const char *name, TClass *type);
   virtual ~AliAnalysisDataContainer();

   AliAnalysisDataContainer &operator=(const AliAnalysisDataContainer &cont);
   TObject                  *GetData() const      {return fData;}
   const char               *GetFileName() const  {return fFileName.Data();}
   const char               *GetFolderName() const {return fFolderName.Data();}
   TFile                    *GetFile() const      {return fFile;}
   TClass                   *GetType() const;
   AliAnalysisTask          *GetProducer() const  {return fProducer;}
   TObjArray                *GetConsumers() const {return fConsumers;}
   virtual void              GetEntry(Long64_t ientry);
   void                      Reset()              {fData = 0; fDataReady = kFALSE; SetTouched(kFALSE);}
   void                      ResetDataReady()     {fDataReady = kFALSE;}
   virtual Bool_t            SetData(TObject *data, Option_t *option="");
   void                      SetDataOwned(Bool_t flag) {fOwnedData = flag;}
   void                      SetExchange(Bool_t flag) {TObject::SetBit(kExchangeData,flag);}
   void                      SetPostEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kPostEventLoop,flag);}
   void                      SetSpecialOutput(Bool_t flag=kTRUE) {TObject::SetBit(kSpecialOutput,flag);}
   void                      SetRegisterDataset(Bool_t flag=kTRUE) {TObject::SetBit(kRegisterDataset,flag);}
   void                      SetFileName(const char *filename);
   void                      SetFile(TFile *f) {fFile = f;}
   void                      SetProducer(AliAnalysisTask *prod, Int_t islot);
   void                      SetTouched(Bool_t flag=kTRUE)       {TObject::SetBit(kTouchedFlag,flag);}
   void                      AddConsumer(AliAnalysisTask *cons, Int_t islot);
   void                      DeleteData();
   AliAnalysisDataWrapper   *ExportData() const;
   void                      ImportData(AliAnalysisDataWrapper *pack);
   Bool_t                    IsDataReady() const  {return fDataReady;}
   Bool_t                    IsExchange() const      {return TObject::TestBit(kExchangeData);}
   Bool_t                    IsPostEventLoop() const {return TObject::TestBit(kPostEventLoop);}
   Bool_t                    IsSpecialOutput() const {return TObject::TestBit(kSpecialOutput);}
   Bool_t                    IsRegisterDataset() const {return TObject::TestBit(kRegisterDataset);}
   Bool_t                    IsTouched() const       {return TObject::TestBit(kTouchedFlag);}
   Bool_t                    IsOwnedData() const  {return fOwnedData;}
   Bool_t                    ClientsExecuted() const;
   Bool_t                    HasConsumers() const {return (fConsumers != 0);}
   Bool_t                    HasProducer() const  {return (fProducer != 0);}
   virtual Long64_t          Merge(TCollection *list);
   virtual void              NotifyChange(ENotifyMessage /*type*/) {;}
   void                      PrintContainer(Option_t *option="all", Int_t indent=0) const;

private:
   void                      SetType(TClass *type) {fType = type;}   

protected:
   Bool_t                    fDataReady;  
   Bool_t                    fOwnedData;  
   TString                   fFileName;   
   TString                   fFolderName; 
   TFile                    *fFile;       
   TObject                  *fData;       
   TClass                   *fType;       
   AliAnalysisTask          *fProducer;   
   TObjArray                *fConsumers;  
   
   ClassDef(AliAnalysisDataContainer,2)  // Class describing a data container for analysis
};


class AliAnalysisDataWrapper : public TNamed {

public:

enum EAnalysisWrapperFlags {
   kDeleteData = BIT(14)
};     
   AliAnalysisDataWrapper() : TNamed(), fData(NULL) {}
   AliAnalysisDataWrapper(TObject *data);
   AliAnalysisDataWrapper(const AliAnalysisDataWrapper &other) 
                        : TNamed(other), fData(other.fData) {}
   virtual ~AliAnalysisDataWrapper();
   
   AliAnalysisDataWrapper &operator=(const AliAnalysisDataWrapper &other);

   TObject                  *Data() const {return fData;}
   virtual Long64_t          Merge(TCollection *list);
   void                      SetDeleteData(Bool_t flag=kTRUE) {TObject::SetBit(kDeleteData,flag);}

protected:
   TObject                  *fData;       

   ClassDef(AliAnalysisDataWrapper, 1) // Data wrapper class for exchange via the net
};

class AliAnalysisFileDescriptor : public TObject {

public:
   AliAnalysisFileDescriptor();
   AliAnalysisFileDescriptor(const TFile *file);
   AliAnalysisFileDescriptor(const AliAnalysisFileDescriptor &other);
   virtual ~AliAnalysisFileDescriptor();

   AliAnalysisFileDescriptor &operator=(const AliAnalysisFileDescriptor &other);
   
   void         Done();
   
   const char  *GetGUID() const  {return fGUID;}
   Int_t        GetImage() const {return fImage;}
   const char  *GetLfn() const   {return fLfn;}
   Int_t        GetNreplicas() const {return fNreplicas;}
   Long64_t     GetOpenAt() const {return fOpenedAt;}
   Double_t     GetOpenTime() const {return fOpenTime;}
   const char  *GetPfn() const   {return fPfn;}
   Long64_t     GetReadBytes() const {return fReadBytes;}
   Long64_t     GetSize() const   {return fSize;}
   const char  *GetSE() const     {return fSE;}
   Double_t     GetThroughput() const {return fThroughput;}
   Double_t     GetProcessingTime() const {return fProcessingTime;}
   const char  *GetUrl() const    {return fUrl;}
   Bool_t       IsArchive() const {return fIsArchive;}
   virtual void Print(Option_t *option="") const;
   virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
   void         SetOpenTime(Double_t time) {fOpenTime = time;}
   

protected:   
   TString      fLfn;       
   TString      fGUID;      
   TString      fUrl;       
   TString      fPfn;       
   TString      fSE;        
   Bool_t       fIsArchive; 
   Int_t        fImage;     
   Int_t        fNreplicas; 
   Long64_t     fStartBytes;
   Long64_t     fReadBytes; 
   Long64_t     fSize;      
   Long64_t     fOpenedAt;  
   Double_t     fOpenTime;  
   Double_t     fProcessingTime; 
   Double_t     fThroughput; 
   TStopwatch   fTimer;     
   
   ClassDef(AliAnalysisFileDescriptor,1)  // Class describing a a file processed in the analysis
};

#endif