a quick update to correct a few coding conventions but RS2 and GC2 have been ignored

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

diff --git a/PHOS/AliPHOSPpsdRecPoint.h b/PHOS/AliPHOSPpsdRecPoint.h
index c70ed7ddc86b47dfbab9e35ae87ee8783950f26e..3df80b71cb4d533a8db07c210887bae8f7665105 100644 (file)
--- a/PHOS/AliPHOSPpsdRecPoint.h
+++ b/PHOS/AliPHOSPpsdRecPoint.h
@@ -5,13 +5,11 @@
 
 /* $Id$ */
 
-////////////////////////////////////////////////
-//  Cluster in the PPSD of PHOS               //
-//  Version SUBATECH                          //
-//  Author Yves Schutz     SUBATECH           //
-//      comment: its a list of AliPHOSDigit's //  
-//                                            //
-////////////////////////////////////////////////
+//_________________________________________________________________________
+//  A RecPoint (cluster) in the PPSD 
+//  A PPSD RecPoint ends up to be a single digit
+//  Oh yeah               
+//*--  Yves Schutz (SUBATECH)
 
 // --- ROOT system ---
 
@@ -26,32 +24,48 @@ class AliPHOSPpsdRecPoint : public AliPHOSRecPoint {
 
 public:
 
-  AliPHOSPpsdRecPoint() ;          // ctor   
-  virtual ~AliPHOSPpsdRecPoint() ; // dtor
- void AddDigit(AliDigitNew & digit, Float_t Energy) ;
+  AliPHOSPpsdRecPoint() ;           // ctor   
+  virtual ~AliPHOSPpsdRecPoint(){
+    // dtor
+  }
+  virtual void AddDigit(AliPHOSDigit & digit, Float_t Energy) ;
   Int_t   Compare(TObject * obj) ;                    // method to sort clusters
 
-  Float_t GetDelta(void) {return fDelta ;}
-  Int_t   GetMultiplicity(void) const { return fMulDigit ; } 
-  Int_t   GetMaximumMultiplicity() { return   fMaxDigit ; } 
+  Float_t GetDelta(void) {
+    // returns the parameter used for sorting
+    return fDelta ;
+  }
+  Int_t   GetMultiplicity(void) const { 
+    // returns the multiplicity of digits at the origin of this recpoint
+    return fMulDigit ; 
+  } 
+  Int_t   GetMaximumMultiplicity() { 
+    // returns the maximum allowed digit multiplicity
+    return   fMaxDigit ; 
+  } 
   void    GetLocalPosition(TVector3 &LPos) ; // computes the position in the module of the cluster center 
-  Float_t GetTotalEnergy(void) const { return fAmp ; }    // in Ppsd EMC RecPoint Amp = Energy                                        //projection of ALICE axes on PHOS Module, y = 0 .
+  Float_t GetTotalEnergy(void) const { 
+    // returns the amplitude for this recpoint 
+    // in Ppsd EMC RecPoint Amp = Energy   
+    return fAmp ; 
+  }                             
   Bool_t  GetUp() ;               // true if cluster is in upper ppsd 
-  Bool_t  IsEmc(void) {return kFALSE ; } 
-  Bool_t  IsSortable() const { return kTRUE ; }
+  Bool_t  IsEmc(void) {
+    // tells that this is not a EMC
+    return kFALSE ; 
+  } 
+  Bool_t  IsSortable() const { 
+    // tells that this is a sortable object
+    return kTRUE ; 
+  }
   virtual void  Paint(Option_t * option="");
   void    Print(Option_t * opt = "void") ; 
 
-  //  AliPHOSPpsdRecPoint&  operator = (AliPHOSPpsdRecPoint Clu) ;
-
 private:
 
   Float_t        fDelta ;         // parameter used for sorting
-
-
-public: 
   
-  ClassDef(AliPHOSPpsdRecPoint,1)  // PPSD RecPoint, version 1
+  ClassDef(AliPHOSPpsdRecPoint,1)  // PPSD RecPoint
 
 };