Coding convention
[u/mrichter/AliRoot.git] / PHOS / AliPHOSvFast.h
index 24860250ca82edf83a3064de591825f23f4ff589..da7a6a5634590007ca00187dac8d3031d051edc3 100644 (file)
@@ -3,16 +3,17 @@
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
-////////////////////////////////////////////////
-//  Manager class  for PHOS                   //
-//  Version SUBATECH                          //
-//  Author  Y. Schutz SUBATECH                //
-//       This is the class to be used for     //  
-//       fast simulations                     //
-////////////////////////////////////////////////
-
 /* $Id$ */
 
+//_________________________________________________________________________
+// Implementation of the PHOS manager class for fast simulations     
+// Tracks particles until the reach a grossly designed PHOS module
+// Modify the particles property (momentum, energy, type) according to
+//  the PHOS response function. The result is called a virtual reconstructed
+//  particle.                                
+//                  
+//*-- Author: Yves Schutz (SUBATECH)
+
 // --- ROOT system ---
 #include "TClonesArray.h"
 #include "TRandom.h"
@@ -29,6 +30,11 @@ public:
 
   AliPHOSvFast(void) ;
   AliPHOSvFast(const char *name, const char *title="") ;
+  AliPHOSvFast(const AliPHOSvFast & fast) {
+    // cpy ctor: no implementation yet
+    // requested by the Coding Convention
+    assert(0==1) ; 
+  }
   virtual ~AliPHOSvFast(void) ;
 
   void           AddRecParticle(const AliPHOSFastRecParticle & rp) ; // adds primary particle to the RecParticles list
@@ -40,28 +46,45 @@ public:
   Int_t   IsVersion(void) const { return -1 ; }
   void    MakeBranch(Option_t* opt) ;
   Double_t MakeEnergy(const Double_t energy) ;                       // makes the detected energy    
-  void MakeRecParticle(AliPHOSFastRecParticle & rp) ;                // makes a reconstructes particle from primary
-  Int_t   MakeType(const Text_t * name) ;                            // gets the detected type of particle
-  FastRecParticlesList * FastRecParticles() { return fFastRecParticles ; } // gets TClonesArray of reconstructed particles
-  void           SetBigBox(Int_t index, Float_t value) ;                             
-  Double_t       SigmaE(Double_t energy) ;    // calulates the energy resolution at a given Energy                           
-  virtual void   StepManager(void) ;          // does the tracking through PHOS and a preliminary digitalization
+  TVector3 MakePosition(const Double_t energy, const TVector3 pos, const Double_t th, const Double_t ph) ; 
+                                                                     // makes the detected position
+  void MakeRecParticle(const Int_t modid, const TVector3 pos, AliPHOSFastRecParticle & rp) ;  // makes a reconstructes particle from primary
+  Int_t   MakeType(AliPHOSFastRecParticle & rp) ;                    // gets the detected type of particle
+  // gets TClonesArray of reconstructed particles
+  AliPHOSFastRecParticle::FastRecParticlesList * FastRecParticles() { return fFastRecParticles ; } 
+  virtual void ResetPoints() ; 
+  void         ResetFastRecParticles() ; 
+  void         SetBigBox(Int_t index, Float_t value) ;                             
+  Double_t     SigmaE(Double_t energy) ;    // calulates the energy resolution at a given Energy                           
+  Double_t     SigmaP(Double_t energy, Int_t inc) ; // calulates the position resolution at a given Energy at a given incidence                           
+  virtual void StepManager(void) ;          // does the tracking through PHOS and a preliminary digitalization
+
+  AliPHOSvFast & operator = (const AliPHOSvFast & rvalue)  {
+    // assignement operator requested by coding convention
+    // but not needed
+    assert(0==1) ;
+    return *this ; 
+  }
   
 private:
   
   Float_t fBigBoxX ;                         // main box containing all PHOS (EMC+PPSD)
   Float_t fBigBoxY ;                         // main box containing all PHOS (EMC+PPSD)
   Float_t fBigBoxZ ;                         // main box containing all PHOS (EMC+PPSD)
-  FastRecParticlesList * fFastRecParticles ; // list of particles modified by the response function 
+  AliPHOSFastRecParticle::FastRecParticlesList * fFastRecParticles ; // list of particles modified by the response function 
   AliPHOSGeometry * fGeom ;                  // geometry definition
   Int_t fNRecParticles ;                     // number of detected particles
   TRandom fRan ;                             // random number generator
-  Double_t fResPara1 ;                       // parameter for the energy resolution dependence ; 
-  Double_t fResPara2 ;                       // parameter for the energy resolution dependence ; 
-  Double_t fResPara3 ;                       // parameter for the energy resolution dependence ; 
-
+  Double_t fResPara1 ;                       // parameter for the energy resolution dependence  
+  Double_t fResPara2 ;                       // parameter for the energy resolution dependence  
+  Double_t fResPara3 ;                       // parameter for the energy resolution dependence 
+  Double_t fPosParaA0 ;                      // parameter for the position resolution
+  Double_t fPosParaA1 ;                      // parameter for the position resolution 
+  Double_t fPosParaB0 ;                      // parameter for the position resolution 
+  Double_t fPosParaB1 ;                      // parameter for the position resolution 
+  Double_t fPosParaB2 ;                      // parameter for the position resolution
 
-  ClassDef(AliPHOSvFast,1)  // PHOS main class , version for fast simulation
+  ClassDef(AliPHOSvFast,1)  //  Implementation of the PHOS manager class for fast simulations  
 
 };