Updated comments for Doxygen - corrected warnings
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpVPadRowSegment.h
1 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
2  * See cxx source for full Copyright notice                               */
3
4 // $Id$
5 // $MpId: AliMpVPadRowSegment.h,v 1.7 2006/05/24 13:58:21 ivana Exp $
6
7 /// \ingroup sector
8 /// \class AliMpVPadRowSegment
9 /// \brief The abstract base class for a pad row segment composed of the 
10 /// the identic pads.
11 ///
12 /// \author David Guez, Ivana Hrivnacova; IPN Orsay
13
14 #ifndef ALI_MP_V_PAD_ROW_SEGMENT_H
15 #define ALI_MP_V_PAD_ROW_SEGMENT_H
16
17 #include <TObject.h>
18
19 class AliMpPadRow;
20 class AliMpMotif;
21
22 class AliMpVPadRowSegment : public TObject
23 {
24   public:
25     AliMpVPadRowSegment(AliMpPadRow* padRow, AliMpMotif* motif, 
26                        Int_t motifPositionId, Int_t nofPads);
27     AliMpVPadRowSegment();
28     virtual ~AliMpVPadRowSegment();
29
30     // methods
31     virtual Double_t  LeftBorderX() const = 0;
32     virtual Double_t  RightBorderX() const = 0;
33     virtual Double_t  HalfSizeY() const;
34
35     // get methods
36     virtual AliMpPadRow*  GetPadRow() const;
37     virtual AliMpMotif*   GetMotif() const;    
38     virtual Int_t     GetMotifPositionId() const;
39             Int_t     GetNofPads() const {return fNofPads;}     
40
41     // set methods
42     void  SetOffsetX(Double_t offsetX);  
43
44   protected:
45     AliMpVPadRowSegment(const AliMpVPadRowSegment& right);
46     AliMpVPadRowSegment&  operator = (const AliMpVPadRowSegment& right);
47
48     Double_t  GetOffsetX() const { return fOffsetX; }
49
50   private:
51     // data members
52     Int_t         fNofPads;  ///< number of pads
53     Double_t      fOffsetX;  ///< the x position of the right/left border
54     AliMpPadRow*  fPadRow;   ///< the pad row containing this segment 
55     AliMpMotif*   fMotif;    ///< the motif 
56     Int_t         fMotifPositionId;  ///< the motif position id
57     
58   ClassDef(AliMpVPadRowSegment,1)  // Row segment
59 };
60
61 #endif //ALI_MP_V_PAD_ROW_SEGMENT_H
62