Obsolete TrackReferences related code removed.
[u/mrichter/AliRoot.git] / STEER / AliModule.h
1 #ifndef ALIMODULE_H
2 #define ALIMODULE_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
8 //
9 // This is the basic class for any
10 // ALICE detector module, whether it is 
11 // sensitive or not. Detector classes depend
12 // on this.
13 //
14
15 #include <Riostream.h>
16 #include <TNamed.h>
17 #include <TClonesArray.h>
18
19 #include "AliLog.h"
20 #include "AliTriggerDetector.h"
21
22 class TBrowser;
23 class TArrayI;
24 class TFile;
25 class TTree;
26 class AliLoader;
27 class AliTrackReference;
28 class AliDigitizer;
29 class AliRunDigitizer;
30 class AliVertexer;
31 class AliTracker;
32 class AliESD;
33 class AliRunLoader;
34 class AliRawReader;
35
36
37 class AliModule : public TNamed {
38 public:
39
40   // Creators - distructors
41   AliModule(const char* name, const char *title);
42   AliModule();
43   virtual ~AliModule();
44
45   // Inline functions
46   virtual  Int_t         GetNdigits() const {return 0;}
47   virtual  Int_t         GetNhits()  const {return 0;}
48   virtual  TArrayI      *GetIdtmed()   const {return fIdtmed;}
49   virtual  TList        *Histograms() const {return fHistograms;}
50   virtual  TList        *Nodes()  const {return fNodes;}
51   virtual  TClonesArray *Digits() const {return 0;}
52   virtual  TClonesArray *Hits()   const {return 0;}
53   virtual  TObjArray    *Points() const {return 0;}
54   virtual  Int_t         GetIshunt() const {return 0;}
55   virtual  void          SetIshunt(Int_t) {}
56   virtual  Bool_t        IsActive() const {return fActive;}
57   virtual  Bool_t        IsFolder() const {return kTRUE;}
58   virtual  Int_t&        LoMedium() {return fLoMedium;}
59   virtual  Int_t&        HiMedium() {return fHiMedium;}
60
61   // Module composition
62   virtual void AliMaterial(Int_t imat, const char* name, Float_t a, 
63                            Float_t z, Float_t dens, Float_t radl,
64                            Float_t absl, Float_t *buf=0, Int_t nwbuf=0) const;
65   virtual void AliGetMaterial(Int_t imat, char* name, Float_t &a, 
66                               Float_t &z, Float_t &dens, Float_t &radl,
67                               Float_t &absl) const;
68   virtual void AliMixture(Int_t imat, const char *name, Float_t *a,
69                           Float_t *z, Float_t dens, Int_t nlmat,
70                           Float_t *wmat) const;
71   virtual void AliMedium(Int_t numed, const char *name, Int_t nmat,
72                           Int_t isvol, Int_t ifield, Float_t fieldm,
73                           Float_t tmaxfd, Float_t stemax, Float_t deemax,
74                           Float_t epsil, Float_t stmin, Float_t *ubuf=0,
75                           Int_t nbuf=0) const;
76   virtual void AliMatrix(Int_t &nmat, Float_t theta1, Float_t phi1,
77                           Float_t theta2, Float_t phi2, Float_t theta3,
78                           Float_t phi3) const;
79   
80   // Virtual methods
81   virtual void  BuildGeometry() {};
82   virtual Int_t IsVersion() const =0;
83   
84   
85   // Other methods
86   virtual void        AddDigit(Int_t*, Int_t*){
87   Error("AddDigit","Digits cannot be added to module %s\n",fName.Data());}
88   virtual void        AddHit(Int_t, Int_t*, Float_t *) {
89   Error("AddDigit","Hits cannot be added to module %s\n",fName.Data());}
90   virtual void        Hits2SDigits() {}
91   virtual AliDigitizer* CreateDigitizer(AliRunDigitizer* /*manager*/) const 
92     {return NULL;}
93   virtual AliTriggerDetector* CreateTriggerDetector() const
94     { AliTriggerDetector* det = new AliTriggerDetector(); det->SetName(GetName()); return det;}
95   virtual void        SDigits2Digits() {}
96   virtual void        Hits2Digits() {}
97   virtual void        Digits2Reco() {}
98   virtual void        Digits2Raw();
99   virtual void        Raw2Digits()  {}
100   virtual Bool_t      Raw2SDigits(AliRawReader*) {return kFALSE;}
101   virtual void        QADataMaker (const char *) {} 
102   virtual void        Browse(TBrowser *) {} //PH Do we need it?
103   virtual void        CreateGeometry() {}
104   virtual void        CreateMaterials() {}
105   virtual void        DefineOpticalProperties() {}
106   virtual void        AddAlignableVolumes() const;
107   virtual void        Disable();
108   virtual void        Enable();
109   virtual void        PreTrack(){}
110   virtual void        PostTrack(){}
111   virtual void        FinishEvent() {}
112   virtual void        FinishRun() {}
113   virtual void        FinishPrimary() {}
114   virtual void        Init() {}
115   virtual void        LoadPoints(Int_t ) {}
116   virtual void        UpdateInternalGeometry() {}
117
118
119
120   virtual void        MakeBranch(Option_t * /*opt =" "*/) {}
121   virtual void        MakeTree(Option_t *) {}//skowron 
122
123   virtual AliLoader*  MakeLoader(const char* topfoldername);  
124   virtual AliLoader*  GetLoader() const {return 0x0;} //skowron
125   
126
127   virtual void        Paint(Option_t *) {} //PH Do we need it?
128   virtual void        ResetDigits() {}
129   virtual void        ResetSDigits() {}
130   virtual void        ResetHits() {}
131   virtual void        ResetPoints() {}
132   virtual void        SetTimeGate(Float_t) {}
133   virtual Float_t     GetTimeGate() const {return 1.e10;}
134   virtual void        StepManager() {}
135   virtual void        DisableStepManager() {fEnable = kFALSE;}
136   virtual Bool_t      StepManagerIsEnabled() const {return fEnable;}
137   virtual void        SetBufferSize(Int_t) {}  
138   virtual Float_t     ZMin() const;
139   virtual Float_t     ZMax() const;
140   virtual void        SetEuclidFile(char *material,char *geometry=0);
141   virtual void        ReadEuclid(const char *filnam, char *topvol);
142   virtual void        ReadEuclidMedia(const char *filnam);
143 // Track reference related
144   virtual  AliTrackReference * AddTrackReference(Int_t label, Int_t id = -999);
145   TTree* TreeTR();  //shorcut method for accessing treeTR from folder
146   void                SetRunLoader(AliRunLoader* runLoader) 
147     {fRunLoader = runLoader;}
148   
149 // Quality Assurance methods
150   virtual void CheckQA()    { ; }
151   
152   static void SetDensityFactor(Float_t density) { fgDensityFactor = density; }
153   static Float_t GetDensityFactor() { return fgDensityFactor; }
154   
155 protected:      
156
157   // Data members
158   
159   TString       fEuclidMaterial;  //!Name of the Euclid file for materials (if any)
160   TString       fEuclidGeometry;  //!Name of the Euclid file for geometry (if any)
161   
162   TArrayI      *fIdtmed;      //!List of tracking medium numbers
163   TArrayI      *fIdmate;      //!List of material numbers
164   Int_t         fLoMedium;   //!Minimum tracking medium ID for this Module
165   Int_t         fHiMedium;   //!Maximum tracking medium ID for this Module
166
167   Bool_t        fActive;      //Detector activity flag
168   TList        *fHistograms;  //List of histograms
169   TList        *fNodes;       //List of geometry nodes
170   Bool_t        fEnable;      //StepManager enabling flag
171   Int_t         fMaxIterTrackRef;     //!for track refernce iterator routines
172   Int_t         fCurrentIterTrackRef; //!for track refernce iterator routines
173
174   AliRunLoader* fRunLoader;   //!local pointer to run loader
175
176   static Float_t fgDensityFactor; //! factor that is multiplied to all material densities (ONLY for systematic studies)
177
178  private:
179   AliModule(const AliModule &mod);
180   AliModule& operator=(const AliModule &mod);
181
182   ClassDef(AliModule,8)  //Base class for ALICE Modules
183 };
184 #endif