In mapping:

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

diff --git a/MUON/mapping/AliMpVSegmentation.h b/MUON/mapping/AliMpVSegmentation.h
index 1c868a3a78f1768628c68d35ce8bb5c473febf75..52f7cb1699aa2012158913158ef3823f1e24dc15 100644 (file)
--- a/MUON/mapping/AliMpVSegmentation.h
+++ b/MUON/mapping/AliMpVSegmentation.h
@@ -1,27 +1,38 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-// Category: basic
-//
-// Class AliMpVSegmentation
-// ------------------------
-// The abstract base class for the segmentation.
-// Provides methods related to pads:
-// conversion between pad indices, pad location, pad position;
-// finding pad neighbour.
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $MpId: AliMpVSegmentation.h,v 1.12 2006/05/24 13:58:07 ivana Exp $
+
+/// \ingroup basic
+/// \class AliMpVSegmentation
+/// \brief The abstract base class for the segmentation.
+///
+/// Provides methods related to pads:
+/// conversion between pad indices, pad location, pad position;
+/// finding pad neighbour.
+///
+/// \author David Guez, Ivana Hrivnacova, IPN Orsay;
+///         Laurent Aphecetche, SUBATECH
 
 #ifndef ALI_MP_V_SEGMENTATION_H
 #define ALI_MP_V_SEGMENTATION_H
 
 #include <TObject.h>
-#include <TVector2.h>
 
-#include "AliMpIntPair.h"
 #include "AliMpPadPair.h"
 #include "AliMpPad.h"
-#include "AliMpArea.h"
+#include "AliMpPlaneType.h"
+#include "AliMpStationType.h"
 
 class AliMpVPadIterator;
+class AliMpIntPair;
+class AliMpArea;
+class AliMpMotifPosition;
+
+class TArrayI;
+class TVector2;
+class TObjArray;
 
 class AliMpVSegmentation : public TObject
 {
@@ -29,24 +40,81 @@ class AliMpVSegmentation : public TObject
     AliMpVSegmentation();
     virtual ~AliMpVSegmentation();
   
-    // factory method 
+    //
+    // methods 
+    //
+
+    // factory methods
+    /// Create iterator over pads in the given area 
     virtual AliMpVPadIterator* CreateIterator(const AliMpArea& area) const = 0;
 
-    // methods  
+    /// Create a pad iterator over the whole area
+    virtual AliMpVPadIterator* CreateIterator() const = 0;
+    
+    /// Fill the array with the pads that are neighbours of pad. Returns
+    /// the number of neighbours.
+    virtual Int_t GetNeighbours(const AliMpPad& pad, TObjArray& neighbours,
+                                Bool_t includeSelf=kFALSE,
+                                Bool_t includeVoid=kFALSE) const = 0;
+
+            /// Find pad by location
     virtual AliMpPad PadByLocation(const AliMpIntPair& location, 
-                               Bool_t warning) const = 0;
+                               Bool_t warning = true) const = 0;
+            /// Find pad by indices
     virtual AliMpPad PadByIndices (const AliMpIntPair& indices,  
-                               Bool_t warning) const = 0;
+                               Bool_t warning = true) const = 0;
+            /// Find pad by position
     virtual AliMpPad PadByPosition(const TVector2& position,
-                               Bool_t warning) const = 0;
+                               Bool_t warning = true) const = 0;
 
     virtual AliMpPadPair PadsUp(const AliMpPad& pad) const;
     virtual AliMpPadPair PadsDown(const AliMpPad& pad) const;
     virtual AliMpPadPair PadsLeft(const AliMpPad& pad) const;
     virtual AliMpPadPair PadsRight(const AliMpPad& pad) const;
 
-    virtual Bool_t HasPad(const AliMpIntPair& indices) const = 0;
+            /// Return true if the pad with given indices exists.
+            /// Compared with the PadByIndices method, this one can generally be implemented
+            /// faster, as one does not have to create an AliMpPad object... 
+    virtual Bool_t HasPadByIndices(const AliMpIntPair& indices) const;
+  
+            /// Return true if the pad with given location exists
+    virtual Bool_t HasPadByLocation(const AliMpIntPair& location) const;
+  
+            /// For backward compatibility
+    virtual Bool_t HasPad(const AliMpIntPair& indices) const { return HasPadByIndices(indices); }
+  
+            /// Return maximum pad index in X direction
+    virtual Int_t  MaxPadIndexX() const = 0;
+            /// Return maximum pad index in Y direction
+    virtual Int_t  MaxPadIndexY() const = 0;
+            /// Return the number of pads in the detection element
+    virtual Int_t  NofPads() const = 0;
+
+            /// Fill the given array with the electronic card IDs
+    virtual void GetAllElectronicCardIDs(TArrayI& ecn) const = 0;
+
+            /// Get the number of electronic card IDs 
+    virtual Int_t GetNofElectronicCards() const = 0;
+    
+            /// Whether or not we have a given manu
+    virtual Bool_t HasMotifPosition(Int_t manuId) const = 0;
+  
+            /// Return the position of a given manu (aka motifPosition)
+    virtual AliMpMotifPosition* MotifPosition(Int_t manuId) const = 0;
+
+            /// Return the plane type
+    virtual AliMp::PlaneType PlaneType() const = 0;
     
+            /// Return the station type
+    virtual AliMp::StationType StationType() const = 0;
+
+            /// Return the half-sizes of the detection element
+    virtual TVector2 Dimensions() const = 0;
+    
+            /// Return the position of the origine of the detection element
+    virtual TVector2 Position() const = 0;
+  
+  
   private:  
     // methods
     AliMpPadPair FindPads(const TVector2& position1,