X-Git-Url: http://git.uio.no/git/?a=blobdiff_plain;f=FMD%2FAliFMDEdepMap.h;h=522de6f12d528e95bc687fcb0f40eeec9998727b;hb=749f58fa5f3db8c2fa71e441ec89fd34986fde05;hp=f34fba14754c7fee94f62fbaadba9e25419f2739;hpb=e802be3eafd0ff72856d4497226c183f6a363dfc;p=u%2Fmrichter%2FAliRoot.git

diff --git a/FMD/AliFMDEdepMap.h b/FMD/AliFMDEdepMap.h
index f34fba14754..522de6f12d5 100644
--- a/FMD/AliFMDEdepMap.h
+++ b/FMD/AliFMDEdepMap.h
@@ -5,46 +5,79 @@
  *
  * See cxx source for full Copyright notice                               
  */
+/** @file    AliFMDEdepMap.h
+    @author  Christian Holm Christensen <cholm@nbi.dk>
+    @date    Mon Mar 27 12:39:50 2006
+    @brief   Per strip map of energy deposited and number of hits 
+    @ingroup FMD_sim
+*/
+//
+// 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  
 #ifndef ALIFMDMAP_H
-# include <AliFMDMap.h>
+# include "AliFMDMap.h"
 #endif 
-//____________________________________________________________________
-//
-// Cache of Energy deposited, hit information perr strip
-//
+#ifndef ALIFMDEDEPHITPAIR_H
+# include <AliFMDEdepHitPair.h>
+#endif
 
-//____________________________________________________________________
-class AliFMDEdepHitPair 
-{
- public:
-  Float_t  fEdep;
-  UShort_t fN;
-  AliFMDEdepHitPair() : fEdep(0), fN(0) {}
-};
 
 //____________________________________________________________________
+/** @brief 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 
+    @ingroup FMD_sim
+*/
 class AliFMDEdepMap : public AliFMDMap
 {
 public:
+  /** Copy constructor 
+      @param other Object to copy from. 
+      @return  */
   AliFMDEdepMap(const AliFMDEdepMap& other);
-  AliFMDEdepMap(size_t maxDet = kMaxDetectors, 
-		size_t maxRing= kMaxRings, 
-		size_t maxSec = kMaxSectors, 
-		size_t maxStr = kMaxStrips);
+  /** 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(UShort_t maxDet = kMaxDetectors, 
+		UShort_t maxRing= kMaxRings, 
+		UShort_t maxSec = kMaxSectors, 
+		UShort_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 val Value to reset from */
+  virtual void Reset(const AliFMDEdepHitPair& val);
+  /** Access operator 
+      @param detector Detector 
+      @param ring     Ring 
+      @param sector   Sector  
+      @param strip    Strip
+      @return  reference value stored for the strip */
   virtual AliFMDEdepHitPair& operator()(UShort_t detector, 
-				     Char_t   ring, 
-				     UShort_t sector, 
-				     UShort_t strip);
+					Char_t   ring, 
+					UShort_t sector, 
+					UShort_t strip);
+  /** Access operator 
+      @param detector Detector 
+      @param ring     Ring 
+      @param sector   Sector  
+      @param strip    Strip
+      @return value stored for the strip */
   virtual const AliFMDEdepHitPair& operator()(UShort_t detector, 
-					   Char_t   ring, 
-					   UShort_t sector, 
-					   UShort_t strip) const;
+					      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
+  Int_t             fTotal; //  Total number of entries
+  AliFMDEdepHitPair* fData;  //[fTotal] The data 
+  ClassDef(AliFMDEdepMap, 3) // Cache of edep,hit information per strip
 };
 
 #endif