Rationalisation of the virtual MC interfaces
[u/mrichter/AliRoot.git] / STEER / AliMC.h
1 #ifndef ALI_MC_H
2 #define ALI_MC_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 //                                                                           //
10 //                                                                           //
11 //    Abstract Monte Carlo interface                                          //
12 //                                                                           //
13 //                                                                           //
14 ///////////////////////////////////////////////////////////////////////////////
15
16 #include <TNamed.h>
17 #include <TLorentzVector.h>
18
19 class AliMC;
20
21 R__EXTERN AliMC *gMC;
22
23 class AliMC : public TNamed 
24 {
25   public:
26     AliMC(const char *name, const char *title);
27     AliMC() {}
28     virtual ~AliMC() {fgMC=gMC=0;}
29   
30     // static access method
31     static AliMC* GetMC() { return fgMC; }
32
33     //
34     // methods for building/management of geometry
35     // ------------------------------------------------
36     //
37
38     // functions from GBASE 
39     virtual void  FinishGeometry() = 0; 
40
41     // functions from GCONS 
42     virtual void  Gfmate(Int_t imat, char *name, Float_t &a, Float_t &z,  
43                          Float_t &dens, Float_t &radl, Float_t &absl,
44                          Float_t* ubuf, Int_t& nbuf) = 0; 
45
46     // detector composition
47     virtual void  Material(Int_t& kmat, const char* name, Float_t a, 
48                      Float_t z, Float_t dens, Float_t radl, Float_t absl,
49                      Float_t* buf, Int_t nwbuf) = 0;
50     virtual void  Mixture(Int_t& kmat, const char *name, Float_t *a, 
51                      Float_t *z, Float_t dens, Int_t nlmat, Float_t *wmat) = 0;
52     virtual void  Medium(Int_t& kmed, const char *name, Int_t nmat, 
53                      Int_t isvol, Int_t ifield, Float_t fieldm, Float_t tmaxfd, 
54                      Float_t stemax, Float_t deemax, Float_t epsil, 
55                      Float_t stmin, Float_t* ubuf, Int_t nbuf) = 0;
56     virtual void  Matrix(Int_t& krot, Float_t thetaX, Float_t phiX, 
57                      Float_t thetaY, Float_t phiY, Float_t thetaZ, 
58                      Float_t phiZ) = 0;
59     virtual void  Gstpar(Int_t itmed, const char *param, Float_t parval) = 0; 
60
61     // functions from GGEOM 
62     virtual Int_t Gsvolu(const char *name, const char *shape, Int_t nmed,  
63                          Float_t *upar, Int_t np) = 0; 
64     virtual void  Gsdvn(const char *name, const char *mother, Int_t ndiv, 
65                         Int_t iaxis) = 0; 
66     virtual void  Gsdvn2(const char *name, const char *mother, Int_t ndiv, 
67                          Int_t iaxis, Float_t c0i, Int_t numed) = 0; 
68     virtual void  Gsdvt(const char *name, const char *mother, Float_t step, 
69                         Int_t iaxis, Int_t numed, Int_t ndvmx) = 0; 
70     virtual void  Gsdvt2(const char *name, const char *mother, Float_t step, 
71                          Int_t iaxis, Float_t c0, Int_t numed, Int_t ndvmx) = 0; 
72     virtual void  Gsord(const char *name, Int_t iax) = 0; 
73     virtual void  Gspos(const char *name, Int_t nr, const char *mother,  
74                         Float_t x, Float_t y, Float_t z, Int_t irot, 
75                         const char *konly="ONLY") = 0; 
76     virtual void  Gsposp(const char *name, Int_t nr, const char *mother,  
77                          Float_t x, Float_t y, Float_t z, Int_t irot,
78                          const char *konly, Float_t *upar, Int_t np) = 0; 
79     
80     // functions for drawing
81     virtual void  DrawOneSpec(const char* name) = 0;
82     virtual void  Gsatt(const char* name, const char* att, Int_t val) = 0;
83     virtual void  Gdraw(const char*,Float_t theta = 30, Float_t phi = 30,
84                         Float_t psi = 0, Float_t u0 = 10, Float_t v0 = 10,
85                         Float_t ul = 0.01, Float_t vl = 0.01) = 0;
86
87     // Euclid
88     virtual void WriteEuclid(const char*, const char*, Int_t, Int_t) = 0;
89                                
90     // get methods
91     virtual Int_t VolId(const Text_t* volName) const = 0;
92     virtual const char* VolName(Int_t id) const = 0;
93     virtual Int_t NofVolumes() const = 0;
94
95     //
96     // methods for physics management
97     // ------------------------------------------------
98     //
99  
100     // set methods
101     virtual void SetCut(const char* cutName, Float_t cutValue) = 0;
102     virtual void SetProcess(const char* flagName, Int_t flagValue) = 0;
103     virtual Float_t Xsec(char*, Float_t, Int_t, Int_t) = 0; 
104  
105         // particle table usage         
106     virtual Int_t   IdFromPDG(Int_t id) const =0;  
107     virtual Int_t   PDGFromId(Int_t pdg) const =0;  
108     virtual void    DefineParticles() = 0;      
109   
110     //
111     // methods for step management
112     // ------------------------------------------------
113     //
114
115     // action methods
116     virtual void StopTrack() =0;
117     virtual void StopEvent() =0;   
118
119     // set methods
120     virtual void SetMaxStep(Float_t) = 0;
121     virtual void SetMaxNStep(Int_t) = 0;
122     virtual void SetUserDecay(Int_t) =0;  
123
124     // get methods
125          // tracking volume(s) 
126     virtual Int_t CurrentVolID(Int_t& copyNo) const =0;
127     virtual Int_t CurrentVolOffID(Int_t off, Int_t& copyNo) const =0;
128     virtual const char* CurrentVolName() const =0;
129     virtual const char* CurrentVolOffName(Int_t off) const =0;
130     virtual Int_t CurrentMaterial(Float_t &a, Float_t &z, 
131                     Float_t &dens, Float_t &radl, Float_t &absl) const =0;  
132     virtual Int_t CurrentEvent() const =0; 
133     virtual void  Gmtod(Float_t* xm, Float_t* xd, Int_t iflag) = 0;
134     virtual void  Gdtom(Float_t* xd, Float_t* xm, Int_t iflag)= 0 ;
135     virtual Float_t MaxStep() const =0;
136     virtual Int_t GetMaxNStep() const = 0;
137     virtual Int_t GetMedium() const =0;
138
139         // tracking particle 
140         // dynamic properties
141     virtual void    TrackPosition(TLorentzVector& position) const =0;
142     virtual void    TrackMomentum(TLorentzVector& momentum) const =0;
143     virtual Float_t TrackStep() const =0;
144     virtual Float_t TrackLength() const =0; 
145     virtual Float_t TrackTime() const =0;
146     virtual Float_t Edep() const =0;
147         // static properties
148     virtual Int_t   TrackPid() const =0;
149     virtual Float_t TrackCharge() const =0;
150     virtual Float_t TrackMass() const =0;
151     virtual Float_t Etot() const =0;
152
153         // track status
154     virtual Bool_t  IsTrackInside() const =0;
155     virtual Bool_t  IsTrackEntering() const =0;
156     virtual Bool_t  IsTrackExiting() const =0;
157     virtual Bool_t  IsTrackOut() const =0;
158     virtual Bool_t  IsTrackDisappeared() const =0;
159     virtual Bool_t  IsTrackStop() const =0;
160     virtual Bool_t  IsTrackAlive() const=0;
161
162         // secondaries
163     virtual Int_t NSecondaries() const=0;
164     virtual void  GetSecondary(Int_t isec, Int_t& particleId, 
165                     TLorentzVector& position, TLorentzVector& momentum) =0;
166     virtual const char* ProdProcess() const =0; 
167
168     //
169     // other (then geometry/step/run management) methods
170     // ----------------------------------------------
171     //
172     virtual void Rndm(Float_t* array, const Int_t size) const=0; 
173     
174     //
175     // Geant3 specific methods
176     // !!! need to be transformed to common interface
177     //
178     virtual void Gdopt(const char*,const char*) = 0;
179     virtual void SetClipBox(const char*,Float_t=-9999,Float_t=0, Float_t=-9999,Float_t=0,Float_t=-9999,Float_t=0) = 0;
180     virtual void DefaultRange() = 0;
181     virtual void Gdhead(Int_t, const char*, Float_t=0) = 0;   
182     virtual void Gdman(Float_t, Float_t, const char*) = 0;
183     virtual void SetColors() = 0;
184     virtual void Gtreve() = 0;
185     virtual void Gtreve_root() = 0;
186     virtual void Gckmat(Int_t, char*) = 0;
187     virtual void InitLego() = 0;
188     virtual void Gfpart(Int_t, char*, Int_t&, Float_t&, Float_t&, Float_t&) = 0; 
189     virtual void Gspart(Int_t, const char*, Int_t, Float_t, Float_t, Float_t) = 0; 
190
191   private:
192     static AliMC*  fgMC;
193
194   ClassDef(AliMC,1)  //Geometry Interface Class
195 };
196
197 #endif // ALI_MC_H
198