]> git.uio.no Git - u/mrichter/AliRoot.git/blame - ANALYSIS/AliAnalysisDataContainer.h
Fixes to make the preprocessor more robust in case of missing adc aliases.
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisDataContainer.h
CommitLineData
d3106602 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
c52c2132 22#ifndef ROOT_TString
23#include "TString.h"
24#endif
25
d3106602 26class TClass;
8d7d3b59 27class TFile;
d3106602 28class TObjArray;
c52c2132 29class TCollection;
d3106602 30class AliAnalysisTask;
981f2614 31class AliAnalysisDataWrapper;
d3106602 32
33class AliAnalysisDataContainer : public TNamed {
34
35public:
36enum ENotifyMessage {
37 kDeleteData,
38 kSaveData,
39 kFileChange
40};
c5a87c56 41enum EAnalysisContainerFlags {
13ef3bb0 42 kPostEventLoop = BIT(14),
43 kSpecialOutput = BIT(15)
c5a87c56 44};
d3106602 45 AliAnalysisDataContainer();
37a26056 46 AliAnalysisDataContainer(const AliAnalysisDataContainer &cont);
d3106602 47 AliAnalysisDataContainer(const char *name, TClass *type);
48 virtual ~AliAnalysisDataContainer();
49
37a26056 50 // Assignment
51 AliAnalysisDataContainer &operator=(const AliAnalysisDataContainer &cont);
d3106602 52 // Getters
53 TObject *GetData() const {return fData;}
c52c2132 54 const char *GetFileName() const {return fFileName.Data();}
84fcd93f 55 const char *GetFolderName() const {return fFolderName.Data();}
8d7d3b59 56 TFile *GetFile() const {return fFile;}
c52c2132 57 TClass *GetType() const;
d3106602 58 AliAnalysisTask *GetProducer() const {return fProducer;}
59 TObjArray *GetConsumers() const {return fConsumers;}
60 virtual void GetEntry(Long64_t ientry);
61 // Setters
327eaf46 62 void ResetDataReady() {fDataReady = kFALSE;}
d3106602 63 virtual Bool_t SetData(TObject *data, Option_t *option="");
64 void SetDataOwned(Bool_t flag) {fOwnedData = flag;}
b1310ef5 65 void SetPostEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kPostEventLoop,flag);}
13ef3bb0 66 void SetSpecialOutput(Bool_t flag=kTRUE) {TObject::SetBit(kSpecialOutput,flag);}
84fcd93f 67 void SetFileName(const char *filename);
8d7d3b59 68 void SetFile(TFile *f) {fFile = f;}
d3106602 69 void SetProducer(AliAnalysisTask *prod, Int_t islot);
70 void AddConsumer(AliAnalysisTask *cons, Int_t islot);
71 void DeleteData();
981f2614 72 // Wrapping
73 AliAnalysisDataWrapper *ExportData() const;
74 void ImportData(AliAnalysisDataWrapper *pack);
d3106602 75 // Container status checking
76 Bool_t IsDataReady() const {return fDataReady;}
b1310ef5 77 Bool_t IsPostEventLoop() const {return TObject::TestBit(kPostEventLoop);}
13ef3bb0 78 Bool_t IsSpecialOutput() const {return TObject::TestBit(kSpecialOutput);}
d3106602 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);}
c52c2132 83 // Container merging
84 virtual Long64_t Merge(TCollection *list);
d3106602 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;
c52c2132 89
90private:
91 void SetType(TClass *type) {fType = type;}
92
d3106602 93protected:
94 Bool_t fDataReady; // Flag that data is ready
95 Bool_t fOwnedData; // Flag data ownership
c52c2132 96 TString fFileName; // File storing the data
84fcd93f 97 TString fFolderName; // Folder name in the output file
8d7d3b59 98 TFile *fFile; //! Opened file
d3106602 99 TObject *fData; // Contained data
c52c2132 100 TClass *fType; //! Type of contained data
d3106602 101 AliAnalysisTask *fProducer; // Analysis task to which the slot belongs
102 TObjArray *fConsumers; // List of consumers of the data
103
84fcd93f 104 ClassDef(AliAnalysisDataContainer,2) // Class describing a data container for analysis
d3106602 105};
981f2614 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
113class AliAnalysisDataWrapper : public TNamed {
114
115public:
8167b1d0 116
117enum EAnalysisWrapperFlags {
118 kDeleteData = BIT(14)
119};
981f2614 120 AliAnalysisDataWrapper() : TNamed(), fData(NULL) {}
8167b1d0 121 AliAnalysisDataWrapper(TObject *data);
981f2614 122 AliAnalysisDataWrapper(const AliAnalysisDataWrapper &other)
123 : TNamed(other), fData(other.fData) {}
8167b1d0 124 virtual ~AliAnalysisDataWrapper();
981f2614 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);
8167b1d0 132 void SetDeleteData(Bool_t flag=kTRUE) {TObject::SetBit(kDeleteData,flag);}
981f2614 133
134protected:
135 TObject *fData; // Wrapped data
136
137 ClassDef(AliAnalysisDataWrapper, 1) // Data wrapper class for exchange via the net
138};
139
d3106602 140#endif