IdHelper Class Reference

This is an abstract base class for helper classes that know how to convert Identifier <-> IdentifierHash objects. More...

#include <IdHelper.h>

Inheritance diagram for IdHelper:

Collaboration diagram for IdHelper:

Public Member Functions
virtual	~IdHelper ()=default
virtual int	get_id (const IdentifierHash &hash_id, Identifier &id, const IdContext *context=0) const =0
virtual int	get_hash (const Identifier &id, IdentifierHash &hash_id, const IdContext *context=0) const =0
virtual int	initialize_from_dictionary (const IdDictMgr &dict_mgr)=0
virtual std::string	dictionaryVersion (void) const =0
virtual bool	do_checks () const =0
	Checks are performed by default in debug compilation and NOT in optimized compilation.
virtual void	set_do_checks (bool do_checks)=0
virtual bool	do_neighbours () const =0
	Neighbour initialization is performed by default One can switch or query this mode for any idHelper with the following method:
virtual void	set_do_neighbours (bool do_neighbours)=0
virtual void	setDictVersion (const IdDictMgr &dict_mgr, const std::string &name)=0

Detailed Description

This is an abstract base class for helper classes that know how to convert Identifier <-> IdentifierHash objects.

Definition at line 24 of file IdHelper.h.

Constructor & Destructor Documentation

~IdHelper()

virtual IdHelper::~IdHelper ( )

virtualdefault

Member Function Documentation

dictionaryVersion()

virtual std::string IdHelper::dictionaryVersion ( void ) const

pure virtual

Implemented in AtlasDetectorID.

do_checks()

virtual bool IdHelper::do_checks ( ) const

pure virtual

Checks are performed by default in debug compilation and NOT in optimized compilation.

One can switch or query this mode for any idHelper with the following methods:

Implemented in AtlasDetectorID.

do_neighbours()

virtual bool IdHelper::do_neighbours ( ) const

pure virtual

Neighbour initialization is performed by default One can switch or query this mode for any idHelper with the following method:

Implemented in AtlasDetectorID.

get_hash()

virtual int IdHelper::get_hash ( const Identifier & id, IdentifierHash & hash_id, const IdContext * context = 0 ) const

pure virtual

Implemented in AtlasDetectorID, CaloIDHelper, CaloLVL1_ID, HGTD_ID, JGTowerBase_ID, MuonIdHelper, PixelID, SCT_ID, SiliconID, Tile_Base_ID, TileHWID, TileTBID, and TRT_ID.

get_id()

virtual int IdHelper::get_id ( const IdentifierHash & hash_id, Identifier & id, const IdContext * context = 0 ) const

pure virtual

Implemented in AtlasDetectorID, CaloIDHelper, CaloLVL1_ID, HGTD_ID, JGTowerBase_ID, MuonIdHelper, PixelID, SCT_ID, SiliconID, Tile_Base_ID, TileHWID, TileTBID, and TRT_ID.

initialize_from_dictionary()

virtual int IdHelper::initialize_from_dictionary ( const IdDictMgr & dict_mgr )

pure virtual

Implemented in AtlasDetectorID, CaloCell_Base_ID, CaloCell_ID, CaloDM_ID, CaloLVL1_ID, CscIdHelper, GTower_ID, HGTD_ID, JTower_ID, LArElectrodeID, LArEM_ID, LArEM_SuperCell_ID, LArFCAL_ID, LArFCAL_SuperCell_ID, LArHEC_ID, LArHEC_SuperCell_ID, LArHVLineID, LArMiniFCAL_ID, LArOnline_SuperCellID, LArOnlineID, LArOnlineID_Base, MdtIdHelper, MmIdHelper, MuonIdHelper, PixelID, PLR_ID, RpcIdHelper, SCT_ID, SiliconID, sTgcIdHelper, TgcIdHelper, Tile_SuperCell_ID, TileHWID, TileID, TileTBID, TRT_ID, TTOnlineID, and ZdcID.

set_do_checks()

virtual void IdHelper::set_do_checks ( bool do_checks )

pure virtual

Implemented in AtlasDetectorID.

set_do_neighbours()

virtual void IdHelper::set_do_neighbours ( bool do_neighbours )

pure virtual

Implemented in AtlasDetectorID.

setDictVersion()

virtual void IdHelper::setDictVersion ( const IdDictMgr & dict_mgr, const std::string & name )

pure virtual

Implemented in AtlasDetectorID.

---

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

• IdHelper.h