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