Updated/added comments for Doxygen

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

diff --git a/MUON/mapping/AliMpMotifMap.h b/MUON/mapping/AliMpMotifMap.h
index dddbbe0b48ce31310155515f27504082a7890d5c..4934d7faca1d4761adb994a2048d78eac6667e18 100755 (executable)
--- a/MUON/mapping/AliMpMotifMap.h
+++ b/MUON/mapping/AliMpMotifMap.h
@@ -2,27 +2,28 @@
  * See cxx source for full Copyright notice                               */
 
 // $Id$
-// $MpId: AliMpMotifMap.h,v 1.9 2005/09/26 16:10:46 ivana Exp $
+// $MpId: AliMpMotifMap.h,v 1.14 2006/05/24 13:58:18 ivana Exp $
 
 /// \ingroup motif
 /// \class AliMpMotifMap
 /// \brief Motif map containers
-
+///
 /// The class defines:
 /// - map of motif objects to their string IDs
 /// - map of motif type objects to their string IDs
 /// - map of motif position objects to their string IDs
 /// - map of motif position objects to their global indices
 ///
-/// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_MOTIF_MAP_H
 #define ALI_MP_MOTIF_MAP_H
 
+#include <TObject.h>
+
 #include "AliMpContainers.h"
 
 #ifdef WITH_STL
-#include <map>
 #include "AliMpIntPair.h"
 #endif
 
@@ -30,33 +31,49 @@
 #include "AliMpExMap.h"
 #endif
 
-#include <TObject.h>
-
-class TString;
-class TVector2;
+#ifdef WITH_STL
+#include <map>
+#include <iterator>
+#endif
 
 class AliMpVMotif;
 class AliMpMotifType;
 class AliMpMotifPosition;
 class AliMpMotifMap;
 
+class TArrayI;
+class TString;
+class TVector2;
+
 class AliMpMotifMap : public TObject
 {
   public:
 #ifdef WITH_STL
+    /// Motif map type
     typedef std::map<TString, AliMpVMotif*> MotifMap;
+    /// Motif map iterator type
     typedef MotifMap::const_iterator        MotifMapIterator;
+    /// Motif type map type
     typedef std::map<TString, AliMpMotifType*> MotifTypeMap;
+    /// Motif type map iterator type
     typedef MotifTypeMap::const_iterator       MotifTypeMapIterator;
+    /// Motif position map to int type
     typedef std::map<Int_t, AliMpMotifPosition*>  MotiPositionMap;
+    /// Motif position map to int iterator type
     typedef MotiPositionMap::const_iterator       MotifPositionMapIterator;
+    /// Motif position map to int pair type
     typedef std::map<AliMpIntPair, AliMpMotifPosition*> MotifPositionMap2;
+    /// Motif position map to int pair iterator type
     typedef MotifPositionMap2::const_iterator           MotifPositionMap2Iterator;
 #endif    
 #ifdef WITH_ROOT
+    /// Motif map type
     typedef AliMpExMap MotifMap;
+    /// Motif type map type
     typedef AliMpExMap MotifTypeMap;
+    /// Motif position map to int type
     typedef AliMpExMap MotifPositionMap;
+    /// Motif position map to int pair iterator type
     typedef AliMpExMap MotifPositionMap2;
 #endif    
 
@@ -70,7 +87,7 @@ class AliMpMotifMap : public TObject
     Bool_t  AddMotifType(AliMpMotifType* motifType, Bool_t warn = true);
     Bool_t  AddMotifPosition(AliMpMotifPosition* motifType, Bool_t warn = true);
     void   FillMotifPositionMap2();
-    virtual void Print(const char* /*option*/ = "") const;
+    virtual void Print(const char* option = "ALL") const;
     void   PrintGlobalIndices(const char* fileName) const;
     void   UpdateGlobalIndices(const char* fileName);
    
@@ -80,8 +97,15 @@ class AliMpMotifMap : public TObject
                             const TVector2& padDimensions) const;
     AliMpMotifType*      FindMotifType(const TString& motifTypeID) const;
     AliMpMotifPosition*  FindMotifPosition(Int_t motifPositionID) const;
-    // AliMpMotifPosition*  FindMotifPosition(const AliMpIntPair& indices) const;
 
+    /// Find all motifPositionsIDs (=electronicCardNumbers) handled by this map
+    void    GetAllMotifPositionsIDs(TArrayI& enc) const;
+    UInt_t  GetNofMotifPositions() const;
+    AliMpMotifPosition* GetMotifPosition(UInt_t index) const;
+
+    /// Calculate total number of pads defined in the map
+    Int_t CalculateNofPads() const;
+     
   private:
     // methods
     void  PrintMotif(const AliMpVMotif* motif) const;
@@ -94,15 +118,15 @@ class AliMpMotifMap : public TObject
     void  PrintMotifPositions2() const;
  
     // data members
-    MotifMap           fMotifs;         //  motifs map
-    MotifTypeMap       fMotifTypes;     //  motifs types map
+    MotifMap           fMotifs;         ///< motifs map
+    MotifTypeMap       fMotifTypes;     ///< motifs types map
 #ifdef WITH_STL
-    std::map<Int_t, AliMpMotifPosition*> fMotifPositions; // motif positions map by Id
+    std::map<Int_t, AliMpMotifPosition*> fMotifPositions; ///< motif positions map by Id
 #endif
 #ifdef WITH_ROOT
-    MotifPositionMap   fMotifPositions; //  motifs positions map
+    MotifPositionMap   fMotifPositions; ///< motifs positions map
 #endif
-    MotifPositionMap2  fMotifPositions2;//  motifs positions map
+    MotifPositionMap2  fMotifPositions2;///< motifs positions map
 
   ClassDef(AliMpMotifMap,1)  // motif map
 };