CaloIdCnv::CaloIDHelper_IDDetDescrCnv Class Reference

Base class for calo ID helper converters. More...

#include <CaloIDHelper_IDDetDescrCnv.h>

Inherits DetDescrConverter.

Inherited by CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< CaloCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< CaloCell_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< CaloDM_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< CaloLVL1_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< GTower_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< JTower_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArEM_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArEM_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArFCAL_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArFCAL_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArHEC_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArHEC_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArMiniFCAL_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< Tile_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< TileID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< TileTBID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< TTOnlineID >, and CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< T >.

Collaboration diagram for CaloIdCnv::CaloIDHelper_IDDetDescrCnv:

Public Member Functions
virtual StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&pObj)
	Called by the converter infrastructure to create an object.
virtual long int	repSvcType () const
	Return the service type.
	CaloIDHelper_IDDetDescrCnv (const CLID &clid, ISvcLocator *svcloc)
	Constructor.
virtual StatusCode	createHelper (const std::string &helperKey, IdHelper *&idhelper, DataObject *&pObj)=0
	Create the helper object.
virtual StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
virtual StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&pAddr)
virtual StatusCode	fillRepRefs (IOpaqueAddress *pAddr, DataObject *pObj)
const ServiceHandle< StoreGateSvc > &	detStore () const
	Handle to DetectorStore.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Static Public Member Functions
static long	storageType ()
	Storage type for all DetDescrConverters.

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

Private Attributes
ServiceHandle< StoreGateSvc >	m_detStore
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels).
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging).

Detailed Description

Base class for calo ID helper converters.

This class most of the boilerplate needed toe the converters, and also contains the code for initializing the helper.

The abstract virtual function createHelper is used to actually create the helper and to initialize the DataObject.

Definition at line 52 of file CaloIDHelper_IDDetDescrCnv.h.

Constructor & Destructor Documentation

CaloIDHelper_IDDetDescrCnv()

CaloIdCnv::CaloIDHelper_IDDetDescrCnv::CaloIDHelper_IDDetDescrCnv	(	const CLID &	clid,
		ISvcLocator *	svcloc )

Constructor.

Parameters

clid	The CLID if the class we're constructing.
svcloc	Gaudi service locator.

Definition at line 89 of file CaloIDHelper_IDDetDescrCnv.cxx.

  : DetDescrConverter (clid, svcloc, "CaloIDHelper_IDDetDescrCnv")
{
}

Member Function Documentation

createHelper()

virtual StatusCode CaloIdCnv::CaloIDHelper_IDDetDescrCnv::createHelper ( const std::string & helperKey, IdHelper *& idhelper, DataObject *& pObj )

pure virtual

Create the helper object.

Parameters

helperKey	StoreGate key of the helper.
idhelper[out]	Set to a pointer to the new helper.
pObj[out]	Set to a reference to the created helper.

Implemented in CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< T >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< CaloCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< CaloCell_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< CaloDM_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< CaloLVL1_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< GTower_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< JTower_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArEM_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArEM_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArFCAL_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArFCAL_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArHEC_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArHEC_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< LArMiniFCAL_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< Tile_SuperCell_ID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< TileID >, CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< TileTBID >, and CaloIdCnv::CaloIDHelper_IDDetDescrCnv_T< TTOnlineID >.

createObj()

StatusCode CaloIdCnv::CaloIDHelper_IDDetDescrCnv::createObj ( IOpaqueAddress * pAddr, DataObject *& pObj )

virtual

Called by the converter infrastructure to create an object.

Parameters

pAddr	Address of the object to create.
pObj[out]	Set to a reference to the created helper.

Implements DetDescrConverter.

Definition at line 31 of file CaloIDHelper_IDDetDescrCnv.cxx.

{
  // Get the a name of the class we're converting.
  std::string type_name;
  SmartIF<IClassIDSvc> clidsvc{ service ("ClassIDSvc") };
  CHECK( clidsvc.isValid() );
  CHECK( clidsvc->getTypeNameOfID (objType(), type_name) );
 
  // Get the SG key.
  DetDescrAddress* ddAddr = dynamic_cast<DetDescrAddress*> (pAddr);
  if (!ddAddr) {
    ATH_MSG_ERROR ("Dynamic cast to DetDescrAddress fails!");
    return StatusCode::FAILURE;
  }
  std::string helperKey  = *( ddAddr->par() );
  if (helperKey.empty()) {
    ATH_MSG_DEBUG("No Helper key ");
  }
  else {
    ATH_MSG_DEBUG("Helper key is " << helperKey);
  }
 
  // Get the dictionary manager from the detector store
  const IdDictManager* idDictMgr = 0;
  CHECK( detStore()->retrieve(idDictMgr, "IdDict") );
 
  // Create the helper.
  IdHelper* idhelper = 0;
  CHECK( createHelper (helperKey, idhelper, pObj) );
 
  // Initialize the helper.
  if (idDictMgr->initializeHelper(*idhelper)) {
    ATH_MSG_ERROR("Unable to initialize " << type_name);
    return StatusCode::FAILURE;
  } 
  else {
    ATH_MSG_DEBUG("Initialized " << type_name);
  }
 
  return StatusCode::SUCCESS; 
}

createRep()

StatusCode DetDescrConverter::createRep ( DataObject * pObj, IOpaqueAddress *& pAddr )

virtualinherited

Definition at line 20 of file DetDescrConverter.cxx.

                                                            {
    return StatusCode::SUCCESS;
}

detStore()

const ServiceHandle< StoreGateSvc > & DetDescrConverter::detStore ( ) const

inlineinherited

Handle to DetectorStore.

Definition at line 33 of file DetDescrConverter.h.

{ return m_detStore; }

fillObjRefs()

StatusCode DetDescrConverter::fillObjRefs ( IOpaqueAddress * pAddr, DataObject * pObj )

virtualinherited

Definition at line 15 of file DetDescrConverter.cxx.

                                                         {
    return StatusCode::SUCCESS;
}

fillRepRefs()

StatusCode DetDescrConverter::fillRepRefs ( IOpaqueAddress * pAddr, DataObject * pObj )

virtualinherited

Definition at line 25 of file DetDescrConverter.cxx.

                                                         {
    return StatusCode::SUCCESS;
}

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();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

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 167 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 182 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 user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

repSvcType()

long int CaloIdCnv::CaloIDHelper_IDDetDescrCnv::repSvcType ( ) const

virtual

Return the service type.

Required by the base class.

Definition at line 78 of file CaloIDHelper_IDDetDescrCnv.cxx.

{
  return storageType();
}

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;
}

storageType()

long DetDescrConverter::storageType ( )

staticinherited

Storage type for all DetDescrConverters.

Definition at line 30 of file DetDescrConverter.cxx.

                                    {
    return DetDescr_StorageType;
}

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_detStore

ServiceHandle<StoreGateSvc> DetDescrConverter::m_detStore

privateinherited

Definition at line 42 of file DetDescrConverter.h.

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

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_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

---

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

• CaloIDHelper_IDDetDescrCnv.h
• CaloIDHelper_IDDetDescrCnv.cxx