Effective C++ changes (Andrei)
[u/mrichter/AliRoot.git] / 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 class TClass;
23 class TString;
24 class TObjArray;
25 class AliAnalysisTask;
26 class AliESD;
27
28 class AliAnalysisDataContainer : public TNamed {
29
30 public:
31 enum ENotifyMessage {
32    kDeleteData,
33    kSaveData,
34    kFileChange
35 };   
36    AliAnalysisDataContainer();
37    AliAnalysisDataContainer(const AliAnalysisDataContainer &cont);
38    AliAnalysisDataContainer(const char *name, TClass *type);
39    virtual ~AliAnalysisDataContainer();
40
41    // Assignment
42    AliAnalysisDataContainer &operator=(const AliAnalysisDataContainer &cont);
43    // Getters
44    TObject                  *GetData() const      {return fData;}
45    TClass                   *GetType() const      {return fType;}
46    AliAnalysisTask          *GetProducer() const  {return fProducer;}
47    TObjArray                *GetConsumers() const {return fConsumers;}
48    virtual void              GetEntry(Long64_t ientry);
49    // Setters
50    virtual Bool_t            SetData(TObject *data, Option_t *option="");
51    void                      SetDataOwned(Bool_t flag) {fOwnedData = flag;}
52    void                      SetFileName(const char *name);
53    void                      SetProducer(AliAnalysisTask *prod, Int_t islot);
54    void                      AddConsumer(AliAnalysisTask *cons, Int_t islot);
55    void                      DeleteData();
56    // Container status checking
57    Bool_t                    IsDataReady() const  {return fDataReady;}
58    Bool_t                    IsOwnedData() const  {return fOwnedData;}
59    Bool_t                    ClientsExecuted() const;
60    Bool_t                    HasConsumers() const {return (fConsumers != 0);}
61    Bool_t                    HasProducer() const  {return (fProducer != 0);}
62    // Send a notify signal to the container
63    virtual void              NotifyChange(ENotifyMessage /*type*/) {;}
64    // Print connected tasks/status
65    void                      PrintContainer(Option_t *option="all", Int_t indent=0) const;
66    
67 protected:
68    Bool_t                    fDataReady;  // Flag that data is ready
69    Bool_t                    fOwnedData;  // Flag data ownership
70    TString                   fFileName;   // Name of the file that will store the data if requested
71    TObject                  *fData;       // Contained data
72    TClass                   *fType;       // Type of contained data
73    AliAnalysisTask          *fProducer;   // Analysis task to which the slot belongs
74    TObjArray                *fConsumers;  // List of consumers of the data
75    
76    ClassDef(AliAnalysisDataContainer,1)  // Class describing a data container for analysis
77 };
78 #endif