In mapping:

[u/mrichter/AliRoot.git] / MUON / mapping / AliMpMotifTypePadIterator.cxx

diff --git a/MUON/mapping/AliMpMotifTypePadIterator.cxx b/MUON/mapping/AliMpMotifTypePadIterator.cxx
index a77aa84ae02bda0a9b86c87d97be87ded19f0e02..9b4e68d1b777c0f4d263bf0140a3201c8d28a5d4 100755 (executable)
--- a/MUON/mapping/AliMpMotifTypePadIterator.cxx
+++ b/MUON/mapping/AliMpMotifTypePadIterator.cxx
@@ -1,51 +1,71 @@
+/**************************************************************************
+ * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ *                                                                        *
+ * Author: The ALICE Off-line Project.                                    *
+ * Contributors are mentioned in the code where appropriate.              *
+ *                                                                        *
+ * Permission to use, copy, modify and distribute this software and its   *
+ * documentation strictly for non-commercial purposes is hereby granted   *
+ * without fee, provided that the above copyright notice appears in all   *
+ * copies and that both the copyright notice and this permission notice   *
+ * appear in the supporting documentation. The authors make no claims     *
+ * about the suitability of this software for any purpose. It is          *
+ * provided "as is" without express or implied warranty.                  *
+ **************************************************************************/
+
 // $Id$
+// $MpId: AliMpMotifTypePadIterator.cxx,v 1.6 2006/05/24 13:58:41 ivana Exp $
 // Category: motif
-//
+
+//-----------------------------------------------------------------------------
 // Class AliMpMotifTypePadIterator
 // -------------------------------
 // Class, which defines an iterator over the pads of a given motif type
-//
+// Included in AliRoot: 2003/05/02
 // Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+//-----------------------------------------------------------------------------
 
 #include "AliMpMotifTypePadIterator.h"
 #include "AliMpMotifType.h"
 
+/// \cond CLASSIMP
 ClassImp(AliMpMotifTypePadIterator)
+/// \endcond
 
 //______________________________________________________________________________
 AliMpMotifTypePadIterator::AliMpMotifTypePadIterator():
     AliMpVPadIterator(),
-    fMotifType(0),
+    fkMotifType(0),
     fCurrentPosition(AliMpIntPair::Invalid())
 {
-// default constructor, set the current position to "invalid"
+/// Default constructor, set the current position to "invalid"
 }
 
 //______________________________________________________________________________
 AliMpMotifTypePadIterator::AliMpMotifTypePadIterator( 
                                 const AliMpMotifType* motifType)
   : AliMpVPadIterator(),
-    fMotifType(motifType),
+    fkMotifType(motifType),
     fCurrentPosition(AliMpIntPair::Invalid())
 {
-// normal constructor, let *this to invalid position
+/// Standard constructor, let *this to invalid position
 }
 
 //______________________________________________________________________________
 AliMpMotifTypePadIterator::AliMpMotifTypePadIterator(
                                 const AliMpMotifTypePadIterator& right)
   : AliMpVPadIterator(right),
-    fMotifType(right.fMotifType),
+    fkMotifType(right.fkMotifType),
     fCurrentPosition(right.fCurrentPosition)
     
 {
-// copy constructor
+/// Copy constructor
 }
 
 //______________________________________________________________________________
 AliMpMotifTypePadIterator::~AliMpMotifTypePadIterator()
 {
-// destructor
+/// Destructor
 }
 
 // operators
@@ -54,17 +74,17 @@ AliMpMotifTypePadIterator::~AliMpMotifTypePadIterator()
 AliMpMotifTypePadIterator& 
 AliMpMotifTypePadIterator::operator = (const AliMpMotifTypePadIterator& right)
 {
-// assignement operator
-// if the right hand iterator isn't of good type
-// the current operator is invalidated
+/// Assignment operator.                                                      \n
+/// If the right hand iterator isn't of good type
+/// the current operator is invalidated
 
-  // check assignement to self
+  // check assignment to self
   if (this == &right) return *this;
 
-  // base class assignement
+  // base class assignment
   AliMpVPadIterator::operator=(right);
 
-  fMotifType = right.fMotifType;
+  fkMotifType = right.fkMotifType;
   fCurrentPosition = right.fCurrentPosition;
 
   return *this;
@@ -78,14 +98,14 @@ AliMpMotifTypePadIterator::operator = (const AliMpMotifTypePadIterator& right)
 AliMpIntPair 
 AliMpMotifTypePadIterator::FindFirstPadInLine(AliMpIntPair indices) const
 {
-// Find the indices of the first pad in the same line
-// as the <indices>, and in column, at least equal, to the
-// one of <indices>
+/// Find the indices of the first pad in the same line
+/// as the \a indices, and in column, at least equal, to the
+/// one of \a indices
 
-    if (!fMotifType) return AliMpIntPair::Invalid();
+    if (!fkMotifType) return AliMpIntPair::Invalid();
 
-    while (indices.GetFirst() < fMotifType->GetNofPadsX()) {
-        if (fMotifType->HasPad(indices)) return indices;
+    while (indices.GetFirst() < fkMotifType->GetNofPadsX()) {
+        if (fkMotifType->HasPadByLocalIndices(indices)) return indices;
         indices += AliMpIntPair(1,0);
     }
     return AliMpIntPair::Invalid();
@@ -94,9 +114,9 @@ AliMpMotifTypePadIterator::FindFirstPadInLine(AliMpIntPair indices) const
 //______________________________________________________________________________
 Bool_t AliMpMotifTypePadIterator::IsValid() const
 {
-// Is the iterator in a valid position?
+/// Is the iterator in a valid position?
 
-    return fMotifType!=0 && fCurrentPosition.IsValid();
+    return fkMotifType!=0 && fCurrentPosition.IsValid();
 } 
 
 //
@@ -106,15 +126,15 @@ Bool_t AliMpMotifTypePadIterator::IsValid() const
 //______________________________________________________________________________
 void AliMpMotifTypePadIterator::First()
 {
-// Reset the iterator, so that it points to the first available
-// pad in the motif type
+/// Reset the iterator, so that it points to the first available
+/// pad in the motif type
 
-    if (!fMotifType) {
+    if (!fkMotifType) {
         Invalidate();
         return ;
     }
     fCurrentPosition = AliMpIntPair(0,0);
-    if (fMotifType->HasPad(fCurrentPosition)) return;
+    if (fkMotifType->HasPadByLocalIndices(fCurrentPosition)) return;
     
     
     // if (0,0) is not available
@@ -128,12 +148,12 @@ void AliMpMotifTypePadIterator::First()
 //______________________________________________________________________________
 void AliMpMotifTypePadIterator::Next()
 {
-// Move the iterator to the next valid pad.
+/// Move the iterator to the next valid pad.
 
     //if (!IsValid()) return *this;
     if (!IsValid()) return;
 
-    while (fCurrentPosition.GetSecond() < fMotifType->GetNofPadsY()){
+    while (fCurrentPosition.GetSecond() < fkMotifType->GetNofPadsY()){
         AliMpIntPair nextTry 
          = FindFirstPadInLine(fCurrentPosition + AliMpIntPair(1,0));
         if (nextTry.IsValid()){
@@ -152,16 +172,17 @@ void AliMpMotifTypePadIterator::Next()
 //______________________________________________________________________________
 Bool_t AliMpMotifTypePadIterator::IsDone() const
 {
-// 
+/// Is the iterator in the end ?
+ 
   return !IsValid();
 }
 
 //______________________________________________________________________________
 AliMpPad AliMpMotifTypePadIterator::CurrentItem() const 
 {
-// Returns current pad.
+/// Return current pad.
 
-    if (!fMotifType)
+    if (!fkMotifType)
         return AliMpPad::Invalid();
     else
         return AliMpPad(AliMpIntPair::Invalid(),
@@ -171,7 +192,8 @@ AliMpPad AliMpMotifTypePadIterator::CurrentItem() const
 //______________________________________________________________________________
 void AliMpMotifTypePadIterator::Invalidate()
 {
-// Let the iterator points to the invalid position
+/// Let the iterator point to the invalid position
+
     fCurrentPosition = AliMpIntPair::Invalid();
 
 }