MuonCalib::IRegionSelectorTool Class Reference

#include <IRegionSelectorTool.h>

Inheritance diagram for MuonCalib::IRegionSelectorTool:

Collaboration diagram for MuonCalib::IRegionSelectorTool:

Public Types
typedef MuonFixedId	id_type
	typedef for a MuonFixedId More...
typedef std::string	RegionKey
	typedef for a std::string used as region key More...
typedef std::pair< const MuonCalibSegment *, RegionKey >	Region
	typedef of a pair of a MuonCalibSegment and a RegionKey More...
typedef std::vector< Region >	RegionVec
	typedef of a set of Region (pairs) More...

Public Member Functions
	IRegionSelectorTool ()
virtual	~IRegionSelectorTool ()
	IAlgTool default constructor. More...
virtual RegionKey	getRegionKey (const id_type &id) const =0
	retrieve Interface ID More...
virtual RegionVec	splitIntoRegions (const MuonCalibSegment *seg) const =0
	pure virtual IAlgTool interface: divide MdtSegment into subsegments if they belong to differnt region and generates a key for all of them More...
virtual bool	useRegion (const RegionKey &key) const
	virtual IAlgTool interface: returns true if the generated key corresponds to a region that should be used in calibration. More...
virtual RegionKey	notUsed () const
	virtual IAlgTool interface: returns the notUsed key More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	pure virtual IAlgTool destructor More...

Private Attributes
RegionKey	m_notUsed
	flag for regions that are not to be calibrated More...

Detailed Description

Interface class IRegionSelectorTool. Implementations are used to define the calibration regions within atlas. They should generate a unique key for every region.

Author

Niels.nosp@m..Van.nosp@m..Eldi.nosp@m.k@ce.nosp@m.rn.ch,

Definition at line 40 of file IRegionSelectorTool.h.

Member Typedef Documentation

id_type

typedef MuonFixedId MuonCalib::IRegionSelectorTool::id_type

typedef for a MuonFixedId

Definition at line 43 of file IRegionSelectorTool.h.

Region

typedef std::pair<const MuonCalibSegment*,RegionKey> MuonCalib::IRegionSelectorTool::Region

typedef of a pair of a MuonCalibSegment and a RegionKey

Definition at line 45 of file IRegionSelectorTool.h.

RegionKey

typedef std::string MuonCalib::IRegionSelectorTool::RegionKey

typedef for a std::string used as region key

Definition at line 44 of file IRegionSelectorTool.h.

RegionVec

typedef std::vector<Region> MuonCalib::IRegionSelectorTool::RegionVec

typedef of a set of Region (pairs)

Definition at line 46 of file IRegionSelectorTool.h.

Constructor & Destructor Documentation

IRegionSelectorTool()

MuonCalib::IRegionSelectorTool::IRegionSelectorTool ( )

inline

Definition at line 48 of file IRegionSelectorTool.h.

: m_notUsed("notUsed") {};             

~IRegionSelectorTool()

virtual MuonCalib::IRegionSelectorTool::~IRegionSelectorTool ( )

inlinevirtual

IAlgTool default constructor.

Definition at line 49 of file IRegionSelectorTool.h.

{};                            

Member Function Documentation

getRegionKey()

virtual RegionKey MuonCalib::IRegionSelectorTool::getRegionKey ( const id_type &  id ) const

pure virtual

retrieve Interface ID

pure virtual IAlgTool interface: returns region key for the given id_type

interfaceID()

static const InterfaceID& MuonCalib::IRegionSelectorTool::interfaceID ( )

inlinestatic

pure virtual IAlgTool destructor

Definition at line 51 of file IRegionSelectorTool.h.

{ return IID_IRegionSelectorTool; };  

notUsed()

virtual RegionKey MuonCalib::IRegionSelectorTool::notUsed ( ) const

inlinevirtual

virtual IAlgTool interface: returns the notUsed key

Definition at line 58 of file IRegionSelectorTool.h.

splitIntoRegions()

virtual RegionVec MuonCalib::IRegionSelectorTool::splitIntoRegions ( const MuonCalibSegment *  seg ) const

pure virtual

pure virtual IAlgTool interface: divide MdtSegment into subsegments if they belong to differnt region and generates a key for all of them

useRegion()

virtual bool MuonCalib::IRegionSelectorTool::useRegion ( const RegionKey &  key ) const

inlinevirtual

virtual IAlgTool interface: returns true if the generated key corresponds to a region that should be used in calibration.

Definition at line 57 of file IRegionSelectorTool.h.

Member Data Documentation

m_notUsed

RegionKey MuonCalib::IRegionSelectorTool::m_notUsed

private

flag for regions that are not to be calibrated

Definition at line 61 of file IRegionSelectorTool.h.

---

The documentation for this class was generated from the following file:

• IRegionSelectorTool.h