Changing Digit by VDigit (Laurent)

[u/mrichter/AliRoot.git] / MUON / mapping / AliMpVIndexed.h

diff --git a/MUON/mapping/AliMpVIndexed.h b/MUON/mapping/AliMpVIndexed.h
index d9deb8ce52ace1297d443f3c0a36bca040cc7e67..9d81452beaec421bc1fd571623303749a8a5010f 100755 (executable)
--- a/MUON/mapping/AliMpVIndexed.h
+++ b/MUON/mapping/AliMpVIndexed.h
@@ -1,11 +1,14 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-// Category: basic
-//
-// Class AliMpVIndexed
-// -------------------
-// Class that defines the limits of global pad indices.
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $MpId: AliMpVIndexed.h,v 1.7 2006/05/24 13:58:07 ivana Exp $
+
+/// \ingroup basic
+/// \class AliMpVIndexed
+/// \brief Base class that defines the limits of global pad indices.
+///
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_V_INDEXED_H
 #define ALI_MP_V_INDEXED_H
@@ -19,17 +22,18 @@ class AliMpVPadIterator;
 class AliMpVIndexed : public TObject
 {
  public:
-  AliMpVIndexed(AliMpIntPair lowLimit, AliMpIntPair highLimit);
+  AliMpVIndexed(const AliMpIntPair& lowLimit, const AliMpIntPair& highLimit);
   AliMpVIndexed();
   virtual ~AliMpVIndexed();
 
   // methods
+          /// Create iterator over this element
   virtual AliMpVPadIterator* CreateIterator() const = 0;
   virtual AliMpIntPair  GlobalIndices(const AliMpIntPair& localIndices) const;
 
   // set methods
-  void SetLowIndicesLimit(AliMpIntPair limit);
-  void SetHighIndicesLimit(AliMpIntPair limit);
+  void SetLowIndicesLimit(const AliMpIntPair& limit);
+  void SetHighIndicesLimit(const AliMpIntPair& limit);
 
   // get methods
   Bool_t    HasIndices(const AliMpIntPair& indices) const;
@@ -39,23 +43,27 @@ class AliMpVIndexed : public TObject
 
  private:
   // data members 
-  AliMpIntPair   fLowIndicesLimit;  // the lowest global pad indices 
-  AliMpIntPair   fHighIndicesLimit; // the hihgest global pad indices 
+  AliMpIntPair   fLowIndicesLimit;  ///<  the lowest global pad indices 
+  AliMpIntPair   fHighIndicesLimit; ///<  the hihgest global pad indices 
 
   ClassDef(AliMpVIndexed,1) // A motif position
 };
 
 // inline functions
 
-inline void AliMpVIndexed::SetLowIndicesLimit(AliMpIntPair limit)
+/// Set low indices limit
+inline void AliMpVIndexed::SetLowIndicesLimit(const AliMpIntPair& limit)
 { fLowIndicesLimit = limit; }
   
-inline void AliMpVIndexed::SetHighIndicesLimit(AliMpIntPair limit)
+/// Set high indices limit
+inline void AliMpVIndexed::SetHighIndicesLimit(const AliMpIntPair& limit)
 { fHighIndicesLimit = limit; }  
   
+/// Return low indices limit
 inline AliMpIntPair AliMpVIndexed::GetLowIndicesLimit() const
 { return fLowIndicesLimit; }
 
+/// Return high indices limit
 inline AliMpIntPair AliMpVIndexed::GetHighIndicesLimit() const
 { return fHighIndicesLimit; }