Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpConnection.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: AliMpConnection.h,v 1.8 2006/05/23 13:07:41 ivana Exp $
6
7 /// \ingroup motif
8 /// \class AliMpConnection
9 /// \brief A connection properties.
10 ///
11 /// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
12
13 #ifndef ALI_MP_CONNECTION_H
14 #define ALI_MP_CONNECTION_H
15
16 #include <TObject.h>
17
18 #include "AliMpMotifType.h"
19 #include "AliMpIntPair.h"
20
21 #include <TString.h>
22
23 class AliMpConnection : public TObject
24 {
25   public:
26     AliMpConnection();
27     AliMpConnection(Int_t padNum,Int_t bergNum,Int_t kaptonNum,Int_t gassiNum);
28     virtual ~AliMpConnection();
29
30     // methods
31
32     // accessors
33     Int_t GetBergNum()   const {return fBergNum;}
34     Int_t GetKaptonNum() const {return fKaptonNum;}
35     Int_t GetGassiNum()  const {return fGassiNum;}
36     Int_t GetPadNum()  const {return fPadNum;}
37     AliMpMotifType *GetOwner() const {return fOwner;}
38     
39     AliMpIntPair LocalIndices() const;
40     TString  PadName() const;
41     // modifiers
42     void SetOwner(AliMpMotifType *owner) {fOwner=owner;}
43
44   protected:
45     AliMpConnection(const AliMpConnection& right);
46
47     // operators
48     AliMpConnection& operator=(const AliMpConnection& right);
49     
50   private:
51     // data members
52     Int_t fPadNum;    ///< Pad number
53     Int_t fBergNum;   ///< Berg connector number
54     Int_t fKaptonNum; ///< Kapton connector number
55     Int_t fGassiNum;  ///< Gassiplex channel number
56     AliMpMotifType *fOwner; ///< The motif type which contains this connection
57
58   ClassDef(AliMpConnection,1)  // Connection description
59 };
60
61 // inline functions
62
63 inline TString AliMpConnection::PadName() const 
64 { return fOwner->PadName(fPadNum); }
65
66 inline AliMpIntPair AliMpConnection::LocalIndices() const
67 { return fOwner->FindLocalIndicesByConnection(this);}
68
69 #endif //ALI_MP_CONNECTION_H