New macro to keep track of timing performances of the segmentation methods (Laurent)

[u/mrichter/AliRoot.git] / MUON / mapping / AliMpVMotif.h

diff --git a/MUON/mapping/AliMpVMotif.h b/MUON/mapping/AliMpVMotif.h
index 131de0bf142b45bba538159aa195d631a0720ae8..6bdaf9b7c6e9fa74aae402c405a1c5496af48b40 100755 (executable)
--- a/MUON/mapping/AliMpVMotif.h
+++ b/MUON/mapping/AliMpVMotif.h
@@ -1,12 +1,14 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-// Category: motif
-//
-// Class AliMpVMotif
-// -----------------
-// Class that defines a motif with its unique ID
-// and the motif type.
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $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.
+///
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_V_MOTIF_H
 #define ALI_MP_V_MOTIF_H
@@ -29,32 +31,44 @@ 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;
 
  private:
-  // methods
+  /// Not implemented
+  AliMpVMotif(const AliMpVMotif& right);
+  /// Not implemented
+  AliMpVMotif&  operator = (const AliMpVMotif& right);
 
   // data members 
-  TString         fID;            //identifier
-  AliMpMotifType *fMotifType;     //the motif type
+  TString         fID;        ///< identifier
+  AliMpMotifType *fMotifType; ///< the motif type
 
   ClassDef(AliMpVMotif,1) // A motif with its ID
 };
 
 // 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