Ringer::BuildCaloRingsFctorBase Class Reference

Interface for CaloRings builder functor. More...

#include <CaloRingerReaderUtils.h>

Inheritance diagram for Ringer::BuildCaloRingsFctorBase:

Collaboration diagram for Ringer::BuildCaloRingsFctorBase:

Public Member Functions
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.

Protected Member Functions
	BuildCaloRingsFctorBase (ToolHandle< ICaloRingsBuilder > &builder, IMessageSvc *msgSvc, const std::string &name)
	Main ctor Initialize values.
virtual	~BuildCaloRingsFctorBase ()
StatusCode	prepareToLoopFor (std::size_t nParticles)
	Methods.
void	incrementCounter ()
	Increment particle looping counter.
void	checkRelease ()
	Release the handles when finished looping.

Protected Attributes
ToolHandle< ICaloRingsBuilder > &	m_builder
	Protected Properties.
size_t	m_part_counter
	Hold number of particles already procesed for this event:
size_t	m_part_size
	Hold number of particles to be processed:

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

Private Attributes
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).
SG::WriteHandle< xAOD::CaloRingsContainer > *	m_crContH
	Private Properties.
SG::WriteHandle< xAOD::RingSetContainer > *	m_rsContH
	Keep RingSetContainer handle in scope until finished looping.

Detailed Description

Interface for CaloRings builder functor.

Definition at line 41 of file CaloRingerReaderUtils.h.

Constructor & Destructor Documentation

BuildCaloRingsFctorBase()

Ringer::BuildCaloRingsFctorBase::BuildCaloRingsFctorBase ( ToolHandle< ICaloRingsBuilder > & builder, IMessageSvc * msgSvc, const std::string & name )

inlineprotected

Main ctor Initialize values.

Definition at line 48 of file CaloRingerReaderUtils.h.

                              :
          AthMessaging(msgSvc, name),
          m_builder(builder),
          m_part_counter(0),
          m_part_size(0),
          m_crContH(nullptr),
          m_rsContH(nullptr)
      {;}

~BuildCaloRingsFctorBase()

virtual Ringer::BuildCaloRingsFctorBase::~BuildCaloRingsFctorBase ( )

inlineprotectedvirtual

Definition at line 89 of file CaloRingerReaderUtils.h.

{;}

Member Function Documentation

checkRelease()

void Ringer::BuildCaloRingsFctorBase::checkRelease ( )

protected

Release the handles when finished looping.

Definition at line 43 of file CaloRingerReaderUtils.cxx.

                                           {
  if ( m_part_counter == m_part_size ) {
    delete m_crContH; m_crContH = nullptr;
    delete m_rsContH; m_rsContH = nullptr;
  }
}

incrementCounter()

void Ringer::BuildCaloRingsFctorBase::incrementCounter ( )

inlineprotected

Increment particle looping counter.

Definition at line 81 of file CaloRingerReaderUtils.h.

{ ++m_part_counter; }

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

prepareToLoopFor()

StatusCode Ringer::BuildCaloRingsFctorBase::prepareToLoopFor ( std::size_t nParticles )

protected

Methods.

Set containers and prepare to loop for nParticles

Definition at line 23 of file CaloRingerReaderUtils.cxx.

                                                                           {
  ATH_MSG_DEBUG(" ---------- Preparing to loop for " << nParticles << " particles");
  // Reset counters, set number of particles to nParticles:
  m_part_size = nParticles;
  m_part_counter = 0;
 
  // Make and set the CaloRings and RingSets container
  m_crContH = new SG::WriteHandle<xAOD::CaloRingsContainer >(m_builder->crContName());
  ATH_CHECK(m_crContH->record(std::make_unique<xAOD::CaloRingsContainer>(),
                              std::make_unique<xAOD::CaloRingsAuxContainer>()));
  m_rsContH = new SG::WriteHandle<xAOD::RingSetContainer>(m_builder->rsContName());
  ATH_CHECK(m_rsContH->record(std::make_unique<xAOD::RingSetContainer>(),
                              std::make_unique<xAOD::RingSetAuxContainer>()));
 
  // Set containers which will hold the build CaloRings and reserve one slot per
  // particle as initial guess:
  return m_builder->preExecute( m_crContH->ptr(), m_rsContH->ptr(), nParticles );
}

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

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_builder

ToolHandle<ICaloRingsBuilder>& Ringer::BuildCaloRingsFctorBase::m_builder

protected

Protected Properties.

CaloRings which will be used

Definition at line 64 of file CaloRingerReaderUtils.h.

m_crContH

SG::WriteHandle<xAOD::CaloRingsContainer>* Ringer::BuildCaloRingsFctorBase::m_crContH

private

Private Properties.

Keep CaloRingsContainer handle in scope until finished looping

Definition at line 95 of file CaloRingerReaderUtils.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.

m_part_counter

size_t Ringer::BuildCaloRingsFctorBase::m_part_counter

protected

Hold number of particles already procesed for this event:

Definition at line 66 of file CaloRingerReaderUtils.h.

m_part_size

size_t Ringer::BuildCaloRingsFctorBase::m_part_size

protected

Hold number of particles to be processed:

Definition at line 68 of file CaloRingerReaderUtils.h.

m_rsContH

SG::WriteHandle<xAOD::RingSetContainer>* Ringer::BuildCaloRingsFctorBase::m_rsContH

private

Keep RingSetContainer handle in scope until finished looping.

Definition at line 97 of file CaloRingerReaderUtils.h.

---

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

• CaloRingerReaderUtils.h
• CaloRingerReaderUtils.cxx