Improve documentation

[u/mrichter/AliRoot.git] / PHOS / AliPHOSFastRecParticle.h

diff --git a/PHOS/AliPHOSFastRecParticle.h b/PHOS/AliPHOSFastRecParticle.h
index e4e026ef978b0aab555209cc4f75af7a21bd1c1e..1a5aa93a45c158b79934769f45cc395842d7700a 100644 (file)
--- a/PHOS/AliPHOSFastRecParticle.h
+++ b/PHOS/AliPHOSFastRecParticle.h
@@ -5,12 +5,11 @@
 
 /* $Id$ */
 
-////////////////////////////////////////////////
-//  A  Particle modified by PHOS response     //
-//  Yves Schutz SUBATECH                      //
-//  To become a general class of AliRoot ?    //  
-//                                            //
-////////////////////////////////////////////////
+//_________________________________________________________________________
+//  A  Particle modified by PHOS response and produced by AliPHOSvFast
+//  To become a general class of AliRoot ?    
+//               
+//*-- Author: Yves Schutz (SUBATECH)
 
 // --- ROOT system ---
 
@@ -21,9 +20,8 @@
 
 // --- AliRoot header files ---
 
-//#include "AliPHOSRecParticle.h" 
-
 typedef TClonesArray  FastRecParticlesList ; 
+
 const static Int_t kUNDEFINED     = -1; 
 const static Int_t kGAMMA         = 0 ; 
 const static Int_t kELECTRON      = 1 ;
@@ -42,22 +40,25 @@ public:
   AliPHOSFastRecParticle() {};          // ctor
   AliPHOSFastRecParticle(const AliPHOSFastRecParticle & rp) ;  // ctor
   AliPHOSFastRecParticle(const TParticle & p) ;  // ctor
-  virtual ~AliPHOSFastRecParticle() ; // dtor
+  virtual ~AliPHOSFastRecParticle(){}  // dtor
 
   virtual Int_t DistancetoPrimitive(Int_t px, Int_t py) ; 
   virtual void Draw(Option_t *option) ;  
-  virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py) ; 
+  virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py) ;
+  virtual Int_t * GetPrimaries(Int_t & number) ;
   Int_t GetType() { return fType ; } 
   TString Name() ; 
   virtual void Paint(Option_t * option="");
   void Print() ; 
+  void SetPrimary(Int_t index) { fPrimary = index ; }
   void SetType(Int_t type) { fType = type ; } 
 
 protected:
 
-  Int_t fType ;   // identified particle type
+  Int_t fType ;    // particle type obtained by "virtual" reconstruction
+  Int_t fPrimary ; // (unique) primary particle index 
 
-  ClassDef(AliPHOSFastRecParticle,1)  // Reconstructed Particle, version 1
+  ClassDef(AliPHOSFastRecParticle,1)  // Reconstructed Particle produced by the fast simulation 
 
 };