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