]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - MUON/mapping/AliMpVMotif.h
Changed the crate id numbers accordingly to the new format of regional
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpVMotif.h
index 583759afc6bace5808d546db6cd75266defc77e9..6bdaf9b7c6e9fa74aae402c405a1c5496af48b40 100755 (executable)
@@ -2,13 +2,13 @@
  * See cxx source for full Copyright notice                               */
 
 // $Id$
-// $MpId: AliMpVMotif.h,v 1.7 2006/05/23 13:07:42 ivana Exp $
+// $MpId: AliMpVMotif.h,v 1.8 2006/05/24 13:58:18 ivana Exp $
 
 /// \ingroup motif
 /// \class AliMpVMotif
 /// \brief Abstract base class for a motif with its unique ID and the motif type.
 ///
-/// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_V_MOTIF_H
 #define ALI_MP_V_MOTIF_H
@@ -31,26 +31,31 @@ class AliMpVMotif : public TObject
   // Access methods
   AliMpMotifType  *GetMotifType() const;
   TString          GetID() const;
+                   /// Return the number of pad dimensions
   virtual Int_t    GetNofPadDimensions() const=0;
+                   /// Return the i-th pad dimensions
   virtual TVector2 GetPadDimensions(Int_t i) const=0;
+                   /// Return the dimensions of the pad specified by localIndices
   virtual TVector2 GetPadDimensions(const AliMpIntPair& localIndices) const=0;
 
   // Geometry
+                   /// Return dimensions
   virtual TVector2 Dimensions() const=0;
 
   // Other methods
   AliMpConnection *FindConnectionByLocalPos(const TVector2& localPos) const;
   virtual void Print(Option_t *option) const;
-  virtual TVector2     PadPositionLocal(const AliMpIntPair& localIndices) const=0;
+                   /// Return local position of the pad specified by local indices
+  virtual TVector2 PadPositionLocal(const AliMpIntPair& localIndices) const=0;
+                   /// Return local indices of the pad specified by local position
   virtual AliMpIntPair PadIndicesLocal(const TVector2& localPos) const=0;
 
- protected:
+ private:
+  /// Not implemented
   AliMpVMotif(const AliMpVMotif& right);
+  /// Not implemented
   AliMpVMotif&  operator = (const AliMpVMotif& right);
 
- private:
-  // methods
-
   // data members 
   TString         fID;        ///< identifier
   AliMpMotifType *fMotifType; ///< the motif type
@@ -60,7 +65,10 @@ class AliMpVMotif : public TObject
 
 // inline functions
 
+/// Return the motif type
 inline  AliMpMotifType* AliMpVMotif::GetMotifType() const {return fMotifType;}
+
+/// Return the motif identifier
 inline  TString  AliMpVMotif::GetID() const {return fID;}
 
 #endif //ALI_MP_V_MOTIF_H