ATLAS Offline Software
Loading...
Searching...
No Matches
CP::RNtupleFieldHelpers::ElementProcessor Class Reference

#include <RNtupleFieldHelpers.h>

Inheritance diagram for CP::RNtupleFieldHelpers::ElementProcessor:
Collaboration diagram for CP::RNtupleFieldHelpers::ElementProcessor:

Public Member Functions

 ElementProcessor (const std::string &sgName)
virtual ~ElementProcessor ()=default
 ElementProcessor (const ElementProcessor &)=delete
ElementProcessoroperator= (const ElementProcessor &)=delete
virtual StatusCode retrieveProcess (StoreType &evtStore) override
 retrieve and process the object
virtual StatusCode addBranch (ROOT::RNTupleModel &model, const BranchConfig &branchConfig, OutputBranchData &outputData) override
virtual StatusCode addBranch (TTree &tree, const BranchConfig &branchConfig, OutputBranchData &outputData) override
 Add one branch to the output tree.
void setLevel (MSG::Level lvl)
 Change the current logging level.
Functions providing the same interface as AthMessaging
bool msgLvl (const MSG::Level lvl) const
 Test the output level of the object.
MsgStream & msg () const
 The standard message stream.
MsgStream & msg (const MSG::Level lvl) const
 The standard message stream.

Protected Attributes

std::string m_sgName
std::vector< std::unique_ptr< ElementFieldProcessor > > m_fields

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)

Detailed Description

Definition at line 124 of file RNtupleFieldHelpers.h.

Constructor & Destructor Documentation

◆ ElementProcessor() [1/2]

CP::RNtupleFieldHelpers::ElementProcessor::ElementProcessor ( const std::string & sgName)

Definition at line 367 of file RNtupleFieldHelpers.cxx.

368 : asg::AsgMessaging( "CP::RNtupleFieldHelpers::ElementProcessor/" + sgName ), m_sgName(sgName) {}

◆ ~ElementProcessor()

virtual CP::RNtupleFieldHelpers::ElementProcessor::~ElementProcessor ( )
virtualdefault

◆ ElementProcessor() [2/2]

CP::RNtupleFieldHelpers::ElementProcessor::ElementProcessor ( const ElementProcessor & )
delete

Member Function Documentation

◆ addBranch() [1/2]

StatusCode CP::RNtupleFieldHelpers::ElementProcessor::addBranch ( ROOT::RNTupleModel & model,
const BranchConfig & branchConfig,
OutputBranchData & outputData )
overridevirtual

Implements CP::TreeBranchHelpers::IObjectProcessor.

Definition at line 386 of file RNtupleFieldHelpers.cxx.

388 {
389 if( !auxItemExists(outputData.auxName) ) {
390 ATH_MSG_ERROR("Aux item " << outputData.auxName << " missing");
391 return StatusCode::FAILURE;
392 }
393 m_fields.emplace_back( std::make_unique<ElementFieldProcessor>() );
394 ATH_CHECK( m_fields.back()->setup( model, branchConfig, outputData, msg() ) );
395 return StatusCode::SUCCESS;
396 }
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_ERROR(x)
MsgStream & msg() const
The standard message stream.
std::vector< std::unique_ptr< ElementFieldProcessor > > m_fields

◆ addBranch() [2/2]

StatusCode CP::RNtupleFieldHelpers::ElementProcessor::addBranch ( TTree & ,
const BranchConfig & ,
OutputBranchData &  )
overridevirtual

Add one branch to the output tree.

This function is used during the setup of the output tree to create one branch in it, from one specific auxiliary variable. The type of the variable is figured out at runtime using the auxiliary store infrastructure.

Parameters
treeThe tree to create the branch in
auxNameName of the auxiliary variable to create the branch from
branchNameThe name of the branch to create in the tree
Returns
The usual StatusCode values

Implements CP::TreeBranchHelpers::IObjectProcessor.

Definition at line 398 of file RNtupleFieldHelpers.cxx.

400 {
401 ATH_MSG_ERROR("ElementProcessor::addBranch for TTree should not be called");
402 return StatusCode::FAILURE;
403 }

◆ 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.

40{
42 // If user did not set an explicit level, set a default
43 if (m_lvl == MSG::NIL) {
44 m_lvl = m_imsg ?
45 static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
46 MSG::INFO;
47 }
48}
std::string m_nm
Message source name.
std::atomic< IMessageSvc * > m_imsg
MessageSvc pointer.
std::atomic< MSG::Level > m_lvl
Current logging level.
IMessageSvc * getMessageSvc(bool quiet=false)

◆ msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const
inherited

The standard message stream.

Returns
A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

49 {
50#ifndef XAOD_STANDALONE
51 return ::AthMessaging::msg();
52#else // not XAOD_STANDALONE
53 return m_msg;
54#endif // not XAOD_STANDALONE
55 }

◆ msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl) const
inherited

The standard message stream.

Parameters
lvlThe message level to set the stream to
Returns
A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

57 {
58#ifndef XAOD_STANDALONE
59 return ::AthMessaging::msg( lvl );
60#else // not XAOD_STANDALONE
61 m_msg << lvl;
62 return m_msg;
63#endif // not XAOD_STANDALONE
64 }

◆ msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl) const
inherited

Test the output level of the object.

Parameters
lvlThe message level to test against
Returns
boolean Indicting if messages at given level will be printed
true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

41 {
42#ifndef XAOD_STANDALONE
43 return ::AthMessaging::msgLvl( lvl );
44#else // not XAOD_STANDALONE
45 return m_msg.msgLevel( lvl );
46#endif // not XAOD_STANDALONE
47 }

◆ operator=()

ElementProcessor & CP::RNtupleFieldHelpers::ElementProcessor::operator= ( const ElementProcessor & )
delete

◆ retrieveProcess()

StatusCode CP::RNtupleFieldHelpers::ElementProcessor::retrieveProcess ( StoreType & evtStore)
overridevirtual

retrieve and process the object

This function is called during the event processing to first retrieve the object from the event store, and then to extract all configured variables from the xAOD object into the output variables set up via addBranch.

Implements CP::TreeBranchHelpers::IObjectProcessor.

Reimplemented in CP::RNtupleFieldHelpers::ElementProcessorMet.

Definition at line 370 of file RNtupleFieldHelpers.cxx.

370 {
371 static const bool ALLOW_MISSING = false;
372 const SG::AuxElement* el = getElement( m_sgName,
373 evtStore,
374 ALLOW_MISSING, msg() );
375 if( ! el ) {
376 ATH_MSG_ERROR( "Failed to retrieve object \"" << m_sgName << "\"" );
377 return StatusCode::FAILURE;
378 }
379
380 for( auto& p : m_fields ) {
381 ATH_CHECK( p->process( *el, msg() ) );
382 }
383 return StatusCode::SUCCESS;
384 }
MsgStream & msg() const
The standard message stream.

◆ 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.

29{
30 m_lvl = lvl;
31}

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_fields

std::vector< std::unique_ptr<ElementFieldProcessor> > CP::RNtupleFieldHelpers::ElementProcessor::m_fields
protected

Definition at line 143 of file RNtupleFieldHelpers.h.

◆ m_imsg

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

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_lvl

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

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ 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_sgName

std::string CP::RNtupleFieldHelpers::ElementProcessor::m_sgName
protected

Definition at line 142 of file RNtupleFieldHelpers.h.


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