Initialization of some data members. Copy constructor and assignment operators made...

[u/mrichter/AliRoot.git] / FMD / AliFMDEdepMap.h

diff --git a/FMD/AliFMDEdepMap.h b/FMD/AliFMDEdepMap.h
index 9549eaeb5b4a0ca51935dd55b33589b01400f08a..645b81c7c0c1f6994f608ccdfc91ac52a1845a79 100644 (file)
--- a/FMD/AliFMDEdepMap.h
+++ b/FMD/AliFMDEdepMap.h
@@ -9,42 +9,85 @@
 # include "AliFMDMap.h"
 #endif 
 //____________________________________________________________________
-//
-// Cache of Energy deposited, hit information perr strip
-//
-
-//____________________________________________________________________
+/** Cache of Energy deposited, hit information per strip.
+    Contains a pair of energy deposited @c fEdep and 
+    number of hits @c fN, @c fEdep is the summed energy deposition,
+    and @c fN is the number of hits 
+    @ingroup FMD_sim
+*/
 class AliFMDEdepHitPair 
 {
- public:
-  Float_t  fEdep;
-  UShort_t fN;
+public:
+  Float_t  fEdep; // summed energy deposition
+  UShort_t fN;    // Number of hits
+  /** CTOR  */
   AliFMDEdepHitPair() : fEdep(0), fN(0) {}
+  /** DTOR */
+  virtual ~AliFMDEdepHitPair() {}
+  /** Assignment operator 
+      @param o Object to assign from 
+      @return Reference to this object */
+  AliFMDEdepHitPair& operator=(const AliFMDEdepHitPair& o) 
+  { fEdep = o.fEdep; fN    = o.fN; return *this; }
+  /** Copy CTOR 
+      @param o Object to copy from */
+  AliFMDEdepHitPair(const AliFMDEdepHitPair& o) : fEdep(o.fEdep), fN(o.fN) {}
+  ClassDef(AliFMDEdepHitPair, 1)
 };
 
 //____________________________________________________________________
+/** Map of Energy deposited, hit information per strip.
+    Contains a pair of energy deposited @c fEdep and 
+    number of hits @c fN, @c fEdep is the summed energy deposition,
+    and @c fN is the number of hits */
 class AliFMDEdepMap : public AliFMDMap
 {
 public:
+  /** Copy constructor 
+      @param other Object to copy from. 
+      @return  */
   AliFMDEdepMap(const AliFMDEdepMap& other);
+  /** Constructor 
+      @param maxDet  Number of detectors (3)
+      @param maxRing Number of rings (2)
+      @param maxSec  Number of sectors (40)
+      @param maxStr  Number of strips (20) */
   AliFMDEdepMap(size_t maxDet = kMaxDetectors, 
                size_t maxRing= kMaxRings, 
                size_t maxSec = kMaxSectors, 
                size_t maxStr = kMaxStrips);
+  /** DTOR */
   virtual ~AliFMDEdepMap() { delete [] fData; }
   AliFMDEdepMap& operator=(const AliFMDEdepMap& other);
-  virtual void Clear(const AliFMDEdepHitPair& val=AliFMDEdepHitPair());
+  /** Reset to default */
+  virtual void Reset();
+  /** Reset to value 
+      @param v Value to reset from */
+  virtual void Reset(const AliFMDEdepHitPair& val);
+  /** Access operator 
+      @param det   Detector 
+      @param ring  Ring 
+      @param sec   Sector  
+      @param str   Strip
+      @return  reference value stored for the strip */
   virtual AliFMDEdepHitPair& operator()(UShort_t detector, 
                                     Char_t   ring, 
                                     UShort_t sector, 
                                     UShort_t strip);
+  /** Access operator 
+      @param det   Detector 
+      @param ring  Ring 
+      @param sec   Sector  
+      @param str   Strip
+      @return value stored for the strip */
   virtual const AliFMDEdepHitPair& operator()(UShort_t detector, 
                                           Char_t   ring, 
                                           UShort_t sector, 
                                           UShort_t strip) const;
 protected:
-  AliFMDEdepHitPair* fData;  // The data 
-  ClassDef(AliFMDEdepMap, 1) // Cache of edep,hit information per strip
+  size_t             fTotal; //  Total number of entries
+  AliFMDEdepHitPair* fData;  //[fTotal] The data 
+  ClassDef(AliFMDEdepMap, 2) // Cache of edep,hit information per strip
 };
 
 #endif