Added many comments and some documentation, fixed up some coding violations

[u/mrichter/AliRoot.git] / ITS / AliITSMap.h

diff --git a/ITS/AliITSMap.h b/ITS/AliITSMap.h
index 2ddc06485fbc7811d24b26d779addd385a09ee93..3ce043097d1a45b49cb88df3d67117379a467003 100644 (file)
--- a/ITS/AliITSMap.h
+++ b/ITS/AliITSMap.h
@@ -1,6 +1,11 @@
 #ifndef ALIITSMAP_H
 #define ALIITSMAP_H
-
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice     */
+/* $Id$ */
+////////////////////////////////////////////////
+//  Map Class for ITS.                        //
+////////////////////////////////////////////////
 
 #include <TObject.h>
 
@@ -8,33 +13,32 @@ typedef enum {kEmpty, kUsed, kUnused} FlagType;
 
 //___________________________________________________________________________
 
-class AliITSMap :
-  public TObject {
+class AliITSMap : public TObject {
 
-public:
-  virtual ~AliITSMap() {}
+ public:
+    virtual ~AliITSMap() {}
     // Fill hits from list of digits into hit map
-  virtual  void  FillMap()                                       =0;
+    virtual  void  FillMap()                                       =0;
     // Clear the map
-  virtual  void  ClearMap()                                      =0;
+    virtual  void  ClearMap()                                      =0;
     // Set a single hit
-  virtual  void  SetHit(Int_t iz, Int_t ix, Int_t idigit)        =0;
+    virtual  void  SetHit(Int_t iz, Int_t ix, Int_t idigit)        =0;
     // Set threshold for the signal
-  virtual  void  SetThreshold(Int_t)                             =0;
+    virtual  void  SetThreshold(Int_t)                             =0;
     // Delete a single hit
-  virtual  void  DeleteHit(Int_t iz, Int_t ix)                   =0;
+    virtual  void  DeleteHit(Int_t iz, Int_t ix)                   =0;
     // Flag a hit as used
-  virtual  void  FlagHit(Int_t iz, Int_t ix)                     =0;    
+    virtual  void  FlagHit(Int_t iz, Int_t ix)                     =0;    
     // Get index of hit in the list of digits
-  virtual Int_t  GetHitIndex(Int_t iz, Int_t ix)                 =0;
+    virtual Int_t  GetHitIndex(Int_t iz, Int_t ix)                 =0;
     // Get pointer to digit
-  virtual TObject * GetHit(Int_t iz, Int_t ix)                   =0;
+    virtual TObject * GetHit(Int_t iz, Int_t ix)                   =0;
     // Test hit status
-  virtual FlagType TestHit(Int_t iz, Int_t ix)                   =0;
+    virtual FlagType TestHit(Int_t iz, Int_t ix)                   =0;
     // Get signal from map
-  virtual Double_t  GetSignal(Int_t iz, Int_t ix)                =0;
-  
-  ClassDef(AliITSMap,1) //virtual base class for ITS Hit/Digit Map
+    virtual Double_t  GetSignal(Int_t iz, Int_t ix)                =0;
+
+    ClassDef(AliITSMap,1) //virtual base class for ITS Hit/Digit Map
 
 };