]> git.uio.no Git - u/mrichter/AliRoot.git/blob - MUON/mapping/AliMpSectorAreaHPadIterator.cxx
Updated comments for Doxygen - corrected warnings
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpSectorAreaHPadIterator.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
7  * Permission to use, copy, modify and distribute this software and its   *
8  * documentation strictly for non-commercial purposes is hereby granted   *
9  * without fee, provided that the above copyright notice appears in all   *
10  * copies and that both the copyright notice and this permission notice   *
11  * appear in the supporting documentation. The authors make no claims     *
12  * about the suitability of this software for any purpose. It is          *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16 // $Id$
17 // $MpId: AliMpSectorAreaHPadIterator.cxx,v 1.7 2006/05/24 13:58:46 ivana Exp $
18 // Category: sector
19 //
20 // Class AliMpSectorAreaHPadIterator
21 // ---------------------------------
22 // Class, which defines an iterator over the pads 
23 // inside a given area in a sector in horizontal direction.
24 // Included in AliRoot: 2003/05/02
25 // Authors: David Guez, Ivana Hrivnacova; IPN Orsay
26
27 #include "AliMpSectorAreaHPadIterator.h"
28 #include "AliMpSectorSegmentation.h"
29 #include "AliMpConstants.h"
30
31 #include <Riostream.h>
32
33 /// \cond CLASSIMP
34 ClassImp(AliMpSectorAreaHPadIterator)
35 /// \endcond
36
37 //______________________________________________________________________________
38 AliMpSectorAreaHPadIterator::AliMpSectorAreaHPadIterator(
39                                 const AliMpSectorSegmentation* segmentation,
40                                 const AliMpArea& area) 
41  : AliMpVPadIterator(),
42    fkSegmentation(segmentation),
43    fkArea(area),
44    fCurrentPad(AliMpPad::Invalid()),
45    fCurrentRowPosition(0.)
46 {
47 /// Standard constructor, start in invalid position
48 }
49
50 //______________________________________________________________________________
51 AliMpSectorAreaHPadIterator::AliMpSectorAreaHPadIterator(
52                                 const AliMpSectorAreaHPadIterator& right)
53   : AliMpVPadIterator(right)
54 {
55 /// Protected copy constructor (not provided)
56  
57   Fatal("Copy constructor", "Not implemented");
58 }
59
60 //______________________________________________________________________________
61 AliMpSectorAreaHPadIterator::AliMpSectorAreaHPadIterator()
62  : AliMpVPadIterator(),
63    fkSegmentation(0),
64    fkArea(AliMpArea()),
65    fCurrentPad(AliMpPad::Invalid()),
66    fCurrentRowPosition(0.)
67 {
68 /// Default constructor.
69 }
70
71 //______________________________________________________________________________
72 AliMpSectorAreaHPadIterator::~AliMpSectorAreaHPadIterator()
73 {
74 /// Destructor
75 }
76
77 //
78 // operators
79 //
80
81 //______________________________________________________________________________
82 AliMpSectorAreaHPadIterator& 
83 AliMpSectorAreaHPadIterator::operator = (const AliMpSectorAreaHPadIterator& right)
84 {
85 /// Assignment operator
86
87   // check assignment to self
88   if (this == &right) return *this;
89
90   // base class assignment
91   AliMpVPadIterator::operator=(right);
92
93   fkSegmentation = right.fkSegmentation;
94   fkArea         = right.fkArea;
95   fCurrentPad    = right.fCurrentPad;
96   fCurrentRowPosition = right.fCurrentRowPosition;
97
98   return *this;
99
100
101 // 
102 // private methods
103 //
104
105 //______________________________________________________________________________
106 Bool_t AliMpSectorAreaHPadIterator::IsValid() const
107 {
108 /// Is the iterator in a valid position?
109
110   return fCurrentPad.IsValid() ;
111 }
112
113 //______________________________________________________________________________
114 void AliMpSectorAreaHPadIterator::MoveUp()
115 {
116 /// Increase the current row position and searches the first valid pad.
117
118   Double_t step = 2.* fkSegmentation->GetMinPadDimensions().Y();
119
120   while ( !fCurrentPad.IsValid() && 
121           fCurrentRowPosition + step < fkArea.UpBorder())
122   {
123     fCurrentRowPosition += step;
124     TVector2 position = TVector2(fkArea.LeftBorder(), fCurrentRowPosition);
125     
126     fCurrentPad = fkSegmentation->PadByDirection(position, fkArea.RightBorder());
127   } 
128 }
129
130 //
131 // public methods
132 //
133
134 //______________________________________________________________________________
135 void AliMpSectorAreaHPadIterator::First()
136 {
137 /// Reset the iterator, so that it points to the first available
138 /// pad in the area
139
140   if (!fkSegmentation) {
141     Fatal("First", "Segmentation is not defined");
142     return;
143   }  
144
145   // Start position = left down corner of the area
146   //
147   fCurrentRowPosition = fkArea.DownBorder();
148   TVector2 position(fkArea.LeftDownCorner()); 
149   
150   fCurrentPad = fkSegmentation->PadByDirection(position, fkArea.RightBorder());
151
152   MoveUp();
153   
154   // Set the row position to the center of pad
155   //
156   if (fCurrentPad.IsValid()) fCurrentRowPosition = fCurrentPad.Position().Y();
157 }
158
159 //______________________________________________________________________________
160 void AliMpSectorAreaHPadIterator::Next()
161 {
162 /// Move the iterator to the next valid pad.
163
164   if (!IsValid()) return;
165   
166   // Start position = right board of current pad + little step
167   //
168   TVector2 position 
169     = fCurrentPad.Position() 
170     + TVector2(fCurrentPad.Dimensions().X() + AliMpConstants::LengthStep(), 0.);
171
172   fCurrentPad = fkSegmentation->PadByDirection(position, fkArea.RightBorder());  
173
174   if (fCurrentPad.IsValid()) return;
175
176   MoveUp();
177 }
178
179 //______________________________________________________________________________
180 Bool_t AliMpSectorAreaHPadIterator::IsDone() const
181 {
182 /// Is the iterator in the end ?
183  
184   return !IsValid();
185 }
186
187 //______________________________________________________________________________
188 AliMpPad AliMpSectorAreaHPadIterator::CurrentItem () const 
189 {
190 /// Return current pad.
191
192   return fCurrentPad;
193 }
194 //______________________________________________________________________________
195 void AliMpSectorAreaHPadIterator::Invalidate()
196 {
197 /// Let the iterator point to the invalid position
198
199   fCurrentPad = AliMpPad::Invalid();
200   fCurrentRowPosition = 0;
201 }
202
203
204