Updated/added comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpPadPair.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: AliMpPadPair.h,v 1.10 2006/05/24 13:58:07 ivana Exp $
6
7 /// \ingroup basic
8 /// \class AliMpPadPair
9 /// \brief Wrap up for std::pair<AliMpPad, AliMpPad>
10 /// to avoid problems with CINT.
11 ///
12 /// \author David Guez, Ivana Hrivnacova; IPN Orsay
13
14 #ifndef ALI_MP_PAD_PAIR_H
15 #define ALI_MP_PAD_PAIR_H
16
17 #include <TObject.h>
18
19 #include "AliMpPad.h"
20
21 class AliMpPadPair : public TObject
22 {
23   public:
24     AliMpPadPair(const AliMpPad& pad1, const AliMpPad& pad2);      
25     AliMpPadPair(const AliMpPadPair& pair);      
26     AliMpPadPair();
27     virtual ~AliMpPadPair();
28
29     // operators    
30     Bool_t operator == (const AliMpPadPair& right) const;
31     Bool_t operator != (const AliMpPadPair& right) const;
32     AliMpPadPair& operator = (const AliMpPadPair& right);
33
34     // methods
35     AliMpPad GetFirst() const;  
36     AliMpPad GetSecond() const;  
37
38   private:
39     // data members
40     AliMpPad  fPadFirst;  ///<  first pad
41     AliMpPad  fPadSecond; ///<  second pad
42     
43     
44   ClassDef(AliMpPadPair,1) //utility class for the motif type
45 };
46
47 // inline functions
48
49                 /// Return the first pad
50 inline AliMpPad AliMpPadPair::GetFirst() const  { return fPadFirst; } 
51                 /// Return the second pad
52 inline AliMpPad AliMpPadPair::GetSecond() const { return fPadSecond; } 
53
54
55 #endif //ALI_MP_PAD_PAIR_H