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