Replacement of AliMpIntPair object with algoritmic

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

diff --git a/MUON/mapping/AliMpVRowSegment.h b/MUON/mapping/AliMpVRowSegment.h
index 6e2dde1129095b74c95ab251a6dac6093cfa7c87..b818300a1cd72b43440fab834cd082e0a082214f 100755 (executable)
--- a/MUON/mapping/AliMpVRowSegment.h
+++ b/MUON/mapping/AliMpVRowSegment.h
@@ -1,22 +1,24 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-// Category: sector
-//
-// Class AliMpVRowSegment
-// ----------------------
-// Class describing an interface for a row segment.
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $MpId: AliMpVRowSegment.h,v 1.9 2006/05/24 13:58:21 ivana Exp $
+
+/// \ingroup sector
+/// \class AliMpVRowSegment
+/// \brief An interface for a row segment.
+///
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_V_ROW_SEGMENT_H
 #define ALI_MP_V_ROW_SEGMENT_H
 
-#include <TVector2.h>
-
 #include "AliMpVIndexed.h"
 
+#include <TVector2.h>
+
 class AliMpRow;
 class AliMpVMotif;
-class AliMpIntPair;
 
 class AliMpVRowSegment : public AliMpVIndexed
 {
@@ -24,32 +26,62 @@ class AliMpVRowSegment : public AliMpVIndexed
     AliMpVRowSegment();
     virtual ~AliMpVRowSegment();
 
+    //
     // methods  
+    //
+    
+    /// Return the x coordinate of the left border in the global coordinate system.
     virtual Double_t  LeftBorderX() const = 0;
+    /// Return the x coordinate of the right border in the global coordinate system.
     virtual Double_t  RightBorderX() const = 0;
+    /// Return the half size in y of this row segment.
     virtual Double_t  HalfSizeY() const = 0;
     virtual AliMpVPadIterator* CreateIterator() const;
 
+    //
     // find methods
+    //
+
+    /// Find the motif in the given positions
     virtual AliMpVMotif*  FindMotif(const TVector2& position) const = 0;    
+    /// Find the motif position Id in the given positions
     virtual Int_t     FindMotifPositionId(const TVector2& position) const = 0;
+    /// Has the motif position with the given Id ?
     virtual Bool_t    HasMotifPosition(Int_t motifPositionId) const = 0;
+    /// Return the coordinates of the motif specified with the given motif position Id
     virtual TVector2  MotifCenter(Int_t motifPositionId) const = 0;
 
+    //
     // geometry
+    //
+    
+    /// Return the position of the row segment centre.
     virtual TVector2  Position() const = 0;
+    /// Return the dimensions the row segment centre.
     virtual TVector2  Dimensions() const = 0;
     
+    //
     // set methods
+    //
+
+    /// Calculate offset
     virtual void      SetOffset(const TVector2& offset) = 0;
-    virtual void      SetGlobalIndices() = 0;
-    virtual Int_t     SetIndicesToMotifPosition(Int_t i, 
-                               const AliMpIntPair& indices) = 0;
+    /// Set global indices limits.
+    virtual void      SetGlobalIndices(AliMpRow* rowBefore) = 0;
+    /// Set global indices to i-th motif position and returns next index in x.
+    virtual Int_t     SetIndicesToMotifPosition(Int_t i, MpPair_t indices) = 0;
     
+    //
     // get methods
+    //
+    
+    /// Return the row.which this row segment belongs to
     virtual AliMpRow*  GetRow() const = 0;
+    /// Return the number of motifs in this this row segment.
     virtual Int_t      GetNofMotifs() const = 0;
+    /// Return the i-th motif of this row segment.
     virtual AliMpVMotif*  GetMotif(Int_t i) const = 0;
+    /// Return the i-th motif position Id of this row segment.
     virtual Int_t      GetMotifPositionId(Int_t i) const = 0;
     
   ClassDef(AliMpVRowSegment,1)  //Row segment