AtlasDetectorIDHelper Class Reference

#include <AtlasDetectorIDHelper.h>

Inheritance diagram for AtlasDetectorIDHelper:

Collaboration diagram for AtlasDetectorIDHelper:

Public Types
enum	ERRORS { UNDEFINED = 999 }
using	size_type = Identifier::size_type

Public Member Functions
	AtlasDetectorIDHelper ()
int	initialize_from_dictionary (const IdDictMgr &dict_mgr)
	Initialization from the identifier dictionary. More...
	~AtlasDetectorIDHelper ()=default
size_type	pixel_region_index () const
size_type	sct_region_index () const
size_type	trt_region_index () const
size_type	lar_em_region_index () const
size_type	lar_hec_region_index () const
size_type	lar_fcal_region_index () const
size_type	lvl1_region_index () const
size_type	dm_region_index () const
size_type	tile_region_index () const
size_type	mdt_region_index () const
size_type	csc_region_index () const
size_type	rpc_region_index () const
size_type	tgc_region_index () const
size_type	stgc_region_index () const
size_type	mm_region_index () const
size_type	muon_station_index () const
size_type	alfa_region_index () const
size_type	bcm_region_index () const
size_type	lucid_region_index () const
size_type	zdc_region_index () const
const IdDictField *	station_field () const
bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...
MsgStream &	msg () const
	The standard message stream. More...
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...
void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
bool	m_isHighLuminosityLHC {false}
size_type	m_pixel_region_index {UNDEFINED}
size_type	m_sct_region_index {UNDEFINED}
size_type	m_trt_region_index {UNDEFINED}
size_type	m_lar_em_region_index {UNDEFINED}
size_type	m_lar_hec_region_index {UNDEFINED}
size_type	m_lar_fcal_region_index {UNDEFINED}
size_type	m_lvl1_region_index {UNDEFINED}
size_type	m_dm_region_index {UNDEFINED}
size_type	m_tile_region_index {UNDEFINED}
size_type	m_mdt_region_index {UNDEFINED}
size_type	m_csc_region_index {UNDEFINED}
size_type	m_rpc_region_index {UNDEFINED}
size_type	m_tgc_region_index {UNDEFINED}
size_type	m_mm_region_index {UNDEFINED}
size_type	m_stgc_region_index {UNDEFINED}
size_type	m_muon_station_index {UNDEFINED}
size_type	m_alfa_region_index {UNDEFINED}
size_type	m_bcm_region_index {UNDEFINED}
size_type	m_lucid_region_index {UNDEFINED}
size_type	m_zdc_region_index {UNDEFINED}
bool	m_initialized {false}
IdDictField *	m_station_field {}
std::string	m_nm
	Message source name. More...
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Definition at line 17 of file AtlasDetectorIDHelper.h.

Member Typedef Documentation

size_type

using AtlasDetectorIDHelper::size_type = Identifier::size_type

Definition at line 25 of file AtlasDetectorIDHelper.h.

Member Enumeration Documentation

ERRORS

enum AtlasDetectorIDHelper::ERRORS

Enumerator
UNDEFINED

Definition at line 20 of file AtlasDetectorIDHelper.h.

{ UNDEFINED = 999 };

Constructor & Destructor Documentation

AtlasDetectorIDHelper()

AtlasDetectorIDHelper::AtlasDetectorIDHelper

(

)

Definition at line 10 of file AtlasDetectorIDHelper.cxx.

                                             :
  AthMessaging("AtlasDetectorIDHelper") {
}

~AtlasDetectorIDHelper()

AtlasDetectorIDHelper::~AtlasDetectorIDHelper ( )

default

Member Function Documentation

alfa_region_index()

size_type AtlasDetectorIDHelper::alfa_region_index ( ) const

inline

Definition at line 81 of file AtlasDetectorIDHelper.h.

                                       {
      return m_alfa_region_index;
    }

bcm_region_index()

size_type AtlasDetectorIDHelper::bcm_region_index ( ) const

inline

Definition at line 84 of file AtlasDetectorIDHelper.h.

                                      {
      return m_bcm_region_index;
    }

csc_region_index()

size_type AtlasDetectorIDHelper::csc_region_index ( ) const

inline

Definition at line 62 of file AtlasDetectorIDHelper.h.

                                      {
      return m_csc_region_index;
    }

dm_region_index()

size_type AtlasDetectorIDHelper::dm_region_index ( ) const

inline

Definition at line 53 of file AtlasDetectorIDHelper.h.

                                     {
      return m_dm_region_index;
    }

initialize_from_dictionary()

int AtlasDetectorIDHelper::initialize_from_dictionary

(

const IdDictMgr &

dict_mgr

)

Initialization from the identifier dictionary.

Definition at line 15 of file AtlasDetectorIDHelper.cxx.

                                                                           {
  if (m_initialized) return(0);
 
  m_initialized = true;
 
  AtlasDetectorID atlas_id;
 
  const IdDictDictionary* dict = dict_mgr.find_dictionary("InnerDetector");
  
  auto assignRegionFromAtlasID = [this, &dict](const ExpandedIdentifier& id, 
                                               size_type& regionIdx,
                                               const std::string& techType) {
      if (dict->find_region(id, regionIdx)) {
        ATH_MSG_WARNING("initialize_from_dictionary - unable to find "<<techType<<" region index: id, reg "
          << id << " " << regionIdx);
      }
  };
 
  auto assignRegionIdxFromGrp = [this, &dict](const std::string& grp, size_type& regionIdx) {
    IdDictGroup* group = dict->find_group(grp);
    if (!group || !group->regions().size()) {
        ATH_MSG_VERBOSE("The group "<<grp<<" is not present.");
        regionIdx = UNDEFINED;
        return;
    }
    regionIdx = group->regions().front()->m_index;
    ATH_MSG_VERBOSE("Region index for "<<grp<<" will be assigned to "<<regionIdx);
 
  };
 
  auto assignRegionIdxFromRegion = [this, &dict](const std::string& grp, size_type& regionIdx) {
    IdDictRegion* region = dict->find_region(grp);
    if (!region) {
        ATH_MSG_VERBOSE("The group "<<grp<<" is not present.");
        regionIdx = UNDEFINED;
        return;
    }
    regionIdx = region->m_index;
    ATH_MSG_VERBOSE("Region index for "<<grp<<" will be assigned to "<<regionIdx);
  };
  
 
  if (!dict) {
    ATH_MSG_ERROR("initialize_from_dictionary - cannot access InnerDetector dictionary");
    return 1;
  } 
 
  // Check if this is High Luminosity LHC layout
  if (dict->m_version == "ITkHGTD" || dict->m_version == "ITkHGTDPLR" || dict->m_version == "P2-RUN4") {
    m_isHighLuminosityLHC = true;
  }
  assignRegionFromAtlasID(atlas_id.pixel_exp(), m_pixel_region_index, "pixel");
  // for High Luminosity LHC layout one cannot get the sct region as below, nor
  // is there any trt regions
  if (!m_isHighLuminosityLHC) {
    assignRegionFromAtlasID(atlas_id.sct_exp(), m_sct_region_index, "sct");
    assignRegionFromAtlasID(atlas_id.trt_exp(), m_trt_region_index, "trt");
  }
 
  dict = dict_mgr.find_dictionary("LArCalorimeter");
  if (!dict) {
    ATH_MSG_WARNING("initialize_from_dictionary - cannot access LArCalorimeter dictionary");
    return 1;
  } 
  assignRegionFromAtlasID(atlas_id.lar_em_exp(), m_lar_em_region_index, "lar_em");
  assignRegionFromAtlasID(atlas_id.lar_hec_exp(), m_lar_hec_region_index, "lar_hec");
  assignRegionFromAtlasID(atlas_id.lar_fcal_exp(), m_lar_fcal_region_index, "lar_fcal");
  // Get Calorimetry dictionary for both LVL1 and Dead material
  dict = dict_mgr.find_dictionary("Calorimeter");
  if (!dict) {
    ATH_MSG_WARNING("initialize_from_dictionary - cannot access Calorimeter dictionary");
    return 1;
  }
  // Save index to a LVL1 region for unpacking
  assignRegionIdxFromRegion("Lvl1_0", m_lvl1_region_index);
  // Save index to a Dead Material region for unpacking
  assignRegionIdxFromRegion("DM_4_1_0_0", m_dm_region_index);
 
  dict = dict_mgr.find_dictionary("TileCalorimeter");
  if (!dict) {
    ATH_MSG_WARNING("initialize_from_dictionary - cannot access TileCalorimeter dictionary");
    return 1;
  } 
  
  assignRegionFromAtlasID(atlas_id.tile_exp(), m_tile_region_index, "tile");
 
  dict = dict_mgr.find_dictionary("MuonSpectrometer");
  if (!dict) {
    ATH_MSG_WARNING("initialize_from_dictionary - cannot access MuonSpectrometer dictionary");
    return 1;
  } 
  m_station_field = dict->find_field("stationName");
  if (!m_station_field) {
    ATH_MSG_WARNING("initialize_from_dictionary - cannot access stationName field");
    return 1;
  } else {
    m_muon_station_index = m_station_field->m_index;
  }
  assignRegionIdxFromGrp("mdt", m_mdt_region_index);
  assignRegionIdxFromGrp("csc", m_csc_region_index);
  assignRegionIdxFromGrp("rpc", m_rpc_region_index);
  assignRegionIdxFromGrp("tgc", m_tgc_region_index);
  assignRegionIdxFromGrp("mm", m_mm_region_index);
  assignRegionIdxFromGrp("stgc", m_stgc_region_index);
 
  dict = dict_mgr.find_dictionary("ForwardDetectors");
  if (!dict) {
    ATH_MSG_WARNING("initialize_from_dictionary - cannot access ForwardDetectors dictionary");
    return 1;
  } 
  
  assignRegionFromAtlasID(atlas_id.alfa_exp(), m_alfa_region_index, "alfa");
  assignRegionFromAtlasID(atlas_id.bcm_exp(), m_bcm_region_index, "bcm");
  assignRegionFromAtlasID(atlas_id.lucid_exp(), m_lucid_region_index, "lucid");
  assignRegionFromAtlasID(atlas_id.zdc_exp(), m_zdc_region_index, "zdc");
 
  ATH_MSG_VERBOSE( "AtlasDetectorIDHelper::initialize_from_dictionary ");
  ATH_MSG_VERBOSE( " pixel_region_index     " << m_pixel_region_index);
  ATH_MSG_VERBOSE( " sct_region_index       " << m_sct_region_index);
  ATH_MSG_VERBOSE( " trt_region_index       " << m_trt_region_index);
  ATH_MSG_VERBOSE( " lar_em_region_index    " << m_lar_em_region_index);
  ATH_MSG_VERBOSE( " lar_hec_region_index   " << m_lar_hec_region_index);
  ATH_MSG_VERBOSE( " lar_fcal_region_index  " << m_lar_fcal_region_index);
  ATH_MSG_VERBOSE( " lvl1_region_index      " << m_lvl1_region_index);
  ATH_MSG_VERBOSE( " tile_region_index      " << m_tile_region_index);
  ATH_MSG_VERBOSE( " mdt_region_index       " << m_mdt_region_index);
  ATH_MSG_VERBOSE( " csc_region_index       " << m_csc_region_index);
  ATH_MSG_VERBOSE( " rpc_region_index       " << m_rpc_region_index);
  ATH_MSG_VERBOSE( " tgc_region_index       " << m_tgc_region_index);
  ATH_MSG_VERBOSE( " muon_station_index     " << m_muon_station_index);
  return 0;
}

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  m_lvl = m_imsg ?
    static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
    MSG::INFO;
}

lar_em_region_index()

size_type AtlasDetectorIDHelper::lar_em_region_index ( ) const

inline

Definition at line 41 of file AtlasDetectorIDHelper.h.

                                         {
      return m_lar_em_region_index;
    }

lar_fcal_region_index()

size_type AtlasDetectorIDHelper::lar_fcal_region_index ( ) const

inline

Definition at line 47 of file AtlasDetectorIDHelper.h.

                                           {
      return m_lar_fcal_region_index;
    }

lar_hec_region_index()

size_type AtlasDetectorIDHelper::lar_hec_region_index ( ) const

inline

Definition at line 44 of file AtlasDetectorIDHelper.h.

                                          {
      return m_lar_hec_region_index;
    }

lucid_region_index()

size_type AtlasDetectorIDHelper::lucid_region_index ( ) const

inline

Definition at line 87 of file AtlasDetectorIDHelper.h.

                                        {
      return m_lucid_region_index;
    }

lvl1_region_index()

size_type AtlasDetectorIDHelper::lvl1_region_index ( ) const

inline

Definition at line 50 of file AtlasDetectorIDHelper.h.

                                       {
      return m_lvl1_region_index;
    }

mdt_region_index()

size_type AtlasDetectorIDHelper::mdt_region_index ( ) const

inline

Definition at line 59 of file AtlasDetectorIDHelper.h.

                                      {
      return m_mdt_region_index;
    }

mm_region_index()

size_type AtlasDetectorIDHelper::mm_region_index ( ) const

inline

Definition at line 74 of file AtlasDetectorIDHelper.h.

                                     {
      return m_mm_region_index;
    }

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level  lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (!m_initialized.test_and_set()) initMessaging();
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

muon_station_index()

size_type AtlasDetectorIDHelper::muon_station_index ( ) const

inline

Definition at line 77 of file AtlasDetectorIDHelper.h.

                                         {
      return m_muon_station_index;
    }

pixel_region_index()

size_type AtlasDetectorIDHelper::pixel_region_index ( ) const

inline

Definition at line 32 of file AtlasDetectorIDHelper.h.

                                         {
       return m_pixel_region_index;
    }

rpc_region_index()

size_type AtlasDetectorIDHelper::rpc_region_index ( ) const

inline

Definition at line 65 of file AtlasDetectorIDHelper.h.

                                      {
      return m_rpc_region_index;
    }

sct_region_index()

size_type AtlasDetectorIDHelper::sct_region_index ( ) const

inline

Definition at line 35 of file AtlasDetectorIDHelper.h.

                                      {
      return m_sct_region_index;
    }

setLevel()

void AthMessaging::setLevel ( MSG::Level  lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

station_field()

const IdDictField* AtlasDetectorIDHelper::station_field ( ) const

inline

Definition at line 93 of file AtlasDetectorIDHelper.h.

                                             {
        return m_station_field;
    }

stgc_region_index()

size_type AtlasDetectorIDHelper::stgc_region_index ( ) const

inline

Definition at line 71 of file AtlasDetectorIDHelper.h.

                                       {
      return m_sct_region_index;
    }

tgc_region_index()

size_type AtlasDetectorIDHelper::tgc_region_index ( ) const

inline

Definition at line 68 of file AtlasDetectorIDHelper.h.

                                      {
      return m_tgc_region_index;
    }

tile_region_index()

size_type AtlasDetectorIDHelper::tile_region_index ( ) const

inline

Definition at line 56 of file AtlasDetectorIDHelper.h.

                                       {
      return m_tile_region_index;
    }

trt_region_index()

size_type AtlasDetectorIDHelper::trt_region_index ( ) const

inline

Definition at line 38 of file AtlasDetectorIDHelper.h.

                                      {
      return m_trt_region_index;
    }

zdc_region_index()

size_type AtlasDetectorIDHelper::zdc_region_index ( ) const

inline

Definition at line 90 of file AtlasDetectorIDHelper.h.

                                      {
      return m_zdc_region_index;
    }

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_alfa_region_index

size_type AtlasDetectorIDHelper::m_alfa_region_index {UNDEFINED}

private

Definition at line 114 of file AtlasDetectorIDHelper.h.

m_bcm_region_index

size_type AtlasDetectorIDHelper::m_bcm_region_index {UNDEFINED}

private

Definition at line 115 of file AtlasDetectorIDHelper.h.

m_csc_region_index

size_type AtlasDetectorIDHelper::m_csc_region_index {UNDEFINED}

private

Definition at line 108 of file AtlasDetectorIDHelper.h.

m_dm_region_index

size_type AtlasDetectorIDHelper::m_dm_region_index {UNDEFINED}

private

Definition at line 105 of file AtlasDetectorIDHelper.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

m_initialized

bool AtlasDetectorIDHelper::m_initialized {false}

private

Definition at line 118 of file AtlasDetectorIDHelper.h.

m_isHighLuminosityLHC

bool AtlasDetectorIDHelper::m_isHighLuminosityLHC {false}

private

Definition at line 97 of file AtlasDetectorIDHelper.h.

m_lar_em_region_index

size_type AtlasDetectorIDHelper::m_lar_em_region_index {UNDEFINED}

private

Definition at line 101 of file AtlasDetectorIDHelper.h.

m_lar_fcal_region_index

size_type AtlasDetectorIDHelper::m_lar_fcal_region_index {UNDEFINED}

private

Definition at line 103 of file AtlasDetectorIDHelper.h.

m_lar_hec_region_index

size_type AtlasDetectorIDHelper::m_lar_hec_region_index {UNDEFINED}

private

Definition at line 102 of file AtlasDetectorIDHelper.h.

m_lucid_region_index

size_type AtlasDetectorIDHelper::m_lucid_region_index {UNDEFINED}

private

Definition at line 116 of file AtlasDetectorIDHelper.h.

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

m_lvl1_region_index

size_type AtlasDetectorIDHelper::m_lvl1_region_index {UNDEFINED}

private

Definition at line 104 of file AtlasDetectorIDHelper.h.

m_mdt_region_index

size_type AtlasDetectorIDHelper::m_mdt_region_index {UNDEFINED}

private

Definition at line 107 of file AtlasDetectorIDHelper.h.

m_mm_region_index

size_type AtlasDetectorIDHelper::m_mm_region_index {UNDEFINED}

private

Definition at line 111 of file AtlasDetectorIDHelper.h.

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_muon_station_index

size_type AtlasDetectorIDHelper::m_muon_station_index {UNDEFINED}

private

Definition at line 113 of file AtlasDetectorIDHelper.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_pixel_region_index

size_type AtlasDetectorIDHelper::m_pixel_region_index {UNDEFINED}

private

Definition at line 98 of file AtlasDetectorIDHelper.h.

m_rpc_region_index

size_type AtlasDetectorIDHelper::m_rpc_region_index {UNDEFINED}

private

Definition at line 109 of file AtlasDetectorIDHelper.h.

m_sct_region_index

size_type AtlasDetectorIDHelper::m_sct_region_index {UNDEFINED}

private

Definition at line 99 of file AtlasDetectorIDHelper.h.

m_station_field

IdDictField* AtlasDetectorIDHelper::m_station_field {}

private

Definition at line 119 of file AtlasDetectorIDHelper.h.

m_stgc_region_index

size_type AtlasDetectorIDHelper::m_stgc_region_index {UNDEFINED}

private

Definition at line 112 of file AtlasDetectorIDHelper.h.

m_tgc_region_index

size_type AtlasDetectorIDHelper::m_tgc_region_index {UNDEFINED}

private

Definition at line 110 of file AtlasDetectorIDHelper.h.

m_tile_region_index

size_type AtlasDetectorIDHelper::m_tile_region_index {UNDEFINED}

private

Definition at line 106 of file AtlasDetectorIDHelper.h.

m_trt_region_index

size_type AtlasDetectorIDHelper::m_trt_region_index {UNDEFINED}

private

Definition at line 100 of file AtlasDetectorIDHelper.h.

m_zdc_region_index

size_type AtlasDetectorIDHelper::m_zdc_region_index {UNDEFINED}

private

Definition at line 117 of file AtlasDetectorIDHelper.h.

---

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

• AtlasDetectorIDHelper.h
• AtlasDetectorIDHelper.cxx