Updated/added comments for Doxygen

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

/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

// $Id$
// $MpId: AliMpSectorSegmentation.h,v 1.15 2006/05/24 13:58:21 ivana Exp $

/// \ingroup sector
/// \class AliMpSectorSegmentation
/// \brief A segmentation of the sector.        
///
/// Provides methods related to pads:                                     \n
/// conversion between pad indices, pad location, pad position;
/// finding pad neighbour.
///
/// \author David Guez, Ivana Hrivnacova; IPN Orsay

#ifndef ALI_MP_SECTOR_SEGMENTATION_H
#define ALI_MP_SECTOR_SEGMENTATION_H

#include "AliMpContainers.h"

#include "AliMpVSegmentation.h"
#include "AliMpPad.h"

#include <TVector2.h>
#ifdef WITH_ROOT
#include <TExMap.h>
#endif

#ifdef WITH_STL
#include <map>
#endif

class AliMpSector;
class AliMpMotifPosition;
class AliMpVPadIterator;
class AliMpIntPair;
class AliMpArea;

class AliMpSectorSegmentation : public AliMpVSegmentation
{
  public:
#ifdef WITH_STL
    /// Pad dimensions map type
    typedef std::map<Int_t, TVector2>         PadDimensionsMap;
    /// Pad dimensions map iterator type
    typedef PadDimensionsMap::const_iterator  PadDimensionsMapCIterator;
#endif
#ifdef WITH_ROOT
    /// Pad dimensions map type
    typedef  TExMap      PadDimensionsMap;
    /// Pad dimensions map iterator type
    typedef  TExMapIter  PadDimensionsMapCIterator;
#endif

  public:
    AliMpSectorSegmentation(const AliMpSector* sector, Bool_t own = false);
    AliMpSectorSegmentation();
    virtual ~AliMpSectorSegmentation();
    
    // factory methods  
    virtual AliMpVPadIterator* CreateIterator(const AliMpArea& area) const;
    virtual AliMpVPadIterator* CreateIterator() const;
    
    AliMpVPadIterator* CreateIterator(const AliMpPad& centerPad,
                                      Bool_t includeCenter=kFALSE) const;

     Int_t GetNeighbours(const AliMpPad& pad, TObjArray& neighbours,
                         Bool_t includeSelf = kFALSE,
                         Bool_t includeVoid = kFALSE) const;
    
    // methods  
    virtual AliMpPad PadByLocation(const AliMpIntPair& location,
                               Bool_t warning = kTRUE) const;
    virtual AliMpPad PadByIndices (const AliMpIntPair& indices, 
                               Bool_t warning = kTRUE) const;
    virtual AliMpPad PadByPosition(const TVector2& position ,
                               Bool_t warning = kTRUE) const;
    virtual AliMpPad PadByDirection(const TVector2& startPosition, 
                               Double_t distance) const;
 
    virtual Int_t  MaxPadIndexX() const;
    virtual Int_t  MaxPadIndexY() const;
    virtual Int_t  NofPads() const;

    virtual Int_t    Zone(const AliMpPad& pad, Bool_t warning = kTRUE) const;
    virtual TVector2 PadDimensions(Int_t zone, Bool_t warning = kTRUE) const;

    virtual Bool_t HasPad(const AliMpIntPair& indices) const;
    Bool_t HasMotifPosition(Int_t motifPositionID) const;
    TVector2 GetMinPadDimensions() const;
    Bool_t CircleTest(const AliMpIntPair& indices) const;
    void   PrintZones() const;
   
    const AliMpSector* GetSector() const;

    virtual void Print(Option_t* opt="") const;
    
    virtual void GetAllElectronicCardIDs(TArrayI& ecn) const;

    AliMp::PlaneType PlaneType() const;
    
    TVector2 Dimensions() const;
    
  private:
    /// Not implemented
    AliMpSectorSegmentation(const AliMpSectorSegmentation& right);
    /// Not implemented
    AliMpSectorSegmentation&  operator = (const AliMpSectorSegmentation& right);

#ifdef WITH_ROOT
    static const Double_t   fgkS1;  ///< the separators used for conversion
    static const Double_t   fgkS2;  ///< of TVector2 to Long_t
    
    // methods
    Long_t    GetIndex(const TVector2& vector2) const;
    TVector2  GetVector(Long_t index) const;
#endif

    // methods
    void  FillPadDimensionsMap();
    AliMpMotifPosition*  FindMotifPosition(const AliMpIntPair& indices) const;
    virtual AliMpPad PadByXDirection(const TVector2& startPosition, 
                                     Double_t maxX) const;
    virtual AliMpPad PadByYDirection(const TVector2& startPosition, 
                                     Double_t maxY) const;
 
    // data members   
    const AliMpSector*  fkSector;   ///< Sector
    Bool_t              fIsOwner;   ///< Sector ownership     
    AliMpPad*           fPadBuffer; ///< The pad buffer
#ifdef WITH_STL
    PadDimensionsMap    fPadDimensionsMap; ///< Map between zone IDs and pad dimensions
#endif    
#ifdef WITH_ROOT
    mutable PadDimensionsMap  fPadDimensionsMap; ///< Map between zone IDs and pad dimensions
#endif 

    Int_t  fMaxIndexInX;  ///< maximum pad index in x    
    Int_t  fMaxIndexInY;  ///< maximum pad index in y    

  ClassDef(AliMpSectorSegmentation,2)  // Segmentation
};


// inline functions

/// Return the sector
inline const AliMpSector* AliMpSectorSegmentation::GetSector() const
{ return fkSector; }

#endif //ALI_MP_SECTOR_SEGMENTATION_H