CaloNavigator< T, TOPO > Class Template Reference

#include <CaloNavigator.h>

Public Member Functions
	CaloNavigator (const T &home, const TOPO *topology)
T	down () const
	move the navigator west More...
T	east () const
	move the navigator east More...
const TOPO *	getTopology () const
	set the starting position More...
void	home () const
	move the navigator back to the starting point More...
T	north () const
	move the navigator north More...
T	offsetBy (int deltaX, int deltaY) const
	Free movement of arbitray steps. More...
T	operator* () const
	get the current position More...
T	pos () const
	get the current position More...
void	setHome (const T &startingPoint)
	set the starting position More...
void	setTopology (const TOPO *)
	set the starting position More...
T	south () const
	move the navigator south More...
T	up () const
	move the navigator west More...
T	west () const
	move the navigator west More...

Protected Attributes
T	currentPoint_
const TOPO *	myTopology_
T	startingPoint_

Detailed Description

template<class T, class TOPO = CaloSubdetectorTopology>
class CaloNavigator< T, TOPO >

Definition at line 8 of file CaloNavigator.h.

Constructor & Destructor Documentation

template<class T, class TOPO = CaloSubdetectorTopology>

CaloNavigator< T, TOPO >::CaloNavigator ( const T &  home, const TOPO *  topology  )

inline

Definition at line 11 of file CaloNavigator.h.

                                                      : myTopology_(topology) 
    {
      setHome(home);
    }

Member Function Documentation

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::down ( ) const

inline

move the navigator west

Definition at line 73 of file CaloNavigator.h.

    { 
     currentPoint_=myTopology_->goDown(currentPoint_);
     return currentPoint_;
    } ;

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::east ( ) const

inline

move the navigator east

Definition at line 52 of file CaloNavigator.h.

Referenced by CaloNavigator< EBDetId >::offsetBy().

    { 
     currentPoint_=myTopology_->goEast(currentPoint_);
     return currentPoint_;
    } ;

template<class T, class TOPO = CaloSubdetectorTopology>

const TOPO* CaloNavigator< T, TOPO >::getTopology ( ) const

inline

set the starting position

Definition at line 23 of file CaloNavigator.h.

    {
      return myTopology_;
    }

template<class T , class TOPO >

void CaloNavigator< T, TOPO >::home ( ) const

inline

move the navigator back to the starting point

Definition at line 114 of file CaloNavigator.h.

Referenced by GainSwitchTools::gainSwitchedIdsIn5x5(), and GainSwitchTools::nrCrysWithFlagsIn5x5().

{
  currentPoint_=startingPoint_;
}

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::north ( ) const

inline

move the navigator north

Definition at line 38 of file CaloNavigator.h.

Referenced by CaloNavigator< EBDetId >::offsetBy().

    { 
     currentPoint_=myTopology_->goNorth(currentPoint_);
     return currentPoint_;
    } ;

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::offsetBy ( int  deltaX, int  deltaY  ) const

inline

Free movement of arbitray steps.

Definition at line 80 of file CaloNavigator.h.

Referenced by GainSwitchTools::gainSwitchedIdsIn5x5(), and GainSwitchTools::nrCrysWithFlagsIn5x5().

    {
      for(int x=0; x < abs(deltaX) && currentPoint_ != T(0); x++)
    {
      if(deltaX > 0) east();
      else           west();
    }

      for(int y=0; y < abs(deltaY) && currentPoint_ != T(0); y++)
    {
      if(deltaY > 0) north();
      else           south();
    }

      return currentPoint_;

    }

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::operator* ( void  ) const

inline

get the current position

Definition at line 35 of file CaloNavigator.h.

{ return currentPoint_; } 

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::pos ( ) const

inline

get the current position

Definition at line 32 of file CaloNavigator.h.

{ return currentPoint_; }

template<class T, class TOPO >

void CaloNavigator< T, TOPO >::setHome ( const T &  startingPoint )

inline

set the starting position

Definition at line 106 of file CaloNavigator.h.

Referenced by CaloNavigator< EBDetId >::CaloNavigator().

{
  startingPoint_=startingPoint;
  home();
}

template<class T , class TOPO>

void CaloNavigator< T, TOPO >::setTopology ( const TOPO *  topology )

inline

set the starting position

Definition at line 121 of file CaloNavigator.h.

References ecaldqm::topology().

{
  if (myTopology_ == 0)
    myTopology_=topology;
  else
    return;
}

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::south ( ) const

inline

move the navigator south

Definition at line 45 of file CaloNavigator.h.

Referenced by CaloNavigator< EBDetId >::offsetBy().

    { 
     currentPoint_=myTopology_->goSouth(currentPoint_);
      return currentPoint_;
    } ;

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::up ( ) const

inline

move the navigator west

Definition at line 66 of file CaloNavigator.h.

    { 
      currentPoint_=myTopology_->goUp(currentPoint_);
      return currentPoint_;
    } ;

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::west ( ) const

inline

move the navigator west

Definition at line 59 of file CaloNavigator.h.

Referenced by CaloNavigator< EBDetId >::offsetBy().

    { 
     currentPoint_=myTopology_->goWest(currentPoint_);
     return currentPoint_;
    } ;

Member Data Documentation

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::currentPoint_

mutableprotected

Definition at line 101 of file CaloNavigator.h.

Referenced by CaloNavigator< EBDetId >::down(), CaloNavigator< EBDetId >::east(), CaloNavigator< EBDetId >::north(), CaloNavigator< EBDetId >::offsetBy(), CaloNavigator< EBDetId >::operator*(), CaloNavigator< EBDetId >::pos(), CaloNavigator< EBDetId >::south(), CaloNavigator< EBDetId >::up(), and CaloNavigator< EBDetId >::west().

template<class T, class TOPO = CaloSubdetectorTopology>

const TOPO* CaloNavigator< T, TOPO >::myTopology_

protected

Definition at line 100 of file CaloNavigator.h.

Referenced by CaloNavigator< EBDetId >::down(), CaloNavigator< EBDetId >::east(), CaloNavigator< EBDetId >::getTopology(), CaloNavigator< EBDetId >::north(), CaloNavigator< EBDetId >::south(), CaloNavigator< EBDetId >::up(), and CaloNavigator< EBDetId >::west().

template<class T, class TOPO = CaloSubdetectorTopology>

T CaloNavigator< T, TOPO >::startingPoint_

mutableprotected

Definition at line 101 of file CaloNavigator.h.