#include <RNtupleFieldHelpers.h>

Inheritance diagram for CP::RNtupleFieldHelpers::ContainerProcessor:

Collaboration diagram for CP::RNtupleFieldHelpers::ContainerProcessor:

Public Member Functions
	ContainerProcessor (const std::string &sgName)
virtual	~ContainerProcessor ()=default
	ContainerProcessor (const ContainerProcessor &)=delete
ContainerProcessor &	operator= (const ContainerProcessor &)=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.

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

Private Attributes
std::string	m_sgName
std::vector< std::unique_ptr< ContainerFieldProcessor > >	m_fields
TVirtualCollectionProxy *	m_collProxy = nullptr
int	m_auxElementOffset = -1
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 147 of file RNtupleFieldHelpers.h.

Constructor & Destructor Documentation

◆ ContainerProcessor() [1/2]

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

Definition at line 410 of file RNtupleFieldHelpers.cxx.

411 : asg::AsgMessaging( "CP::RNtupleFieldHelpers::ContainerProcessor/" + sgName ), m_sgName(sgName) {}

CP::RNtupleFieldHelpers::ContainerProcessor::m_sgName

std::string m_sgName

Definition RNtupleFieldHelpers.h:165

◆ ~ContainerProcessor()

virtual CP::RNtupleFieldHelpers::ContainerProcessor::~ContainerProcessor ( )

virtualdefault

◆ ContainerProcessor() [2/2]

CP::RNtupleFieldHelpers::ContainerProcessor::ContainerProcessor ( const ContainerProcessor & )

delete

Member Function Documentation

◆ addBranch() [1/2]

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

overridevirtual

Implements CP::TreeBranchHelpers::IObjectProcessor.

Definition at line 413 of file RNtupleFieldHelpers.cxx.

                                                                           {
        if( !auxItemExists(outputData.auxName) ) {
            ATH_MSG_ERROR("Aux item " << outputData.auxName << " missing");
            return StatusCode::FAILURE;
        }
        m_fields.emplace_back( std::make_unique<ContainerFieldProcessor>() );
        ATH_CHECK( m_fields.back()->setup( model, branchConfig, outputData, msg() ) );
        return StatusCode::SUCCESS;
    }

◆ addBranch() [2/2]

StatusCode CP::RNtupleFieldHelpers::ContainerProcessor::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

tree	The tree to create the branch in
auxName	Name of the auxiliary variable to create the branch from
branchName	The name of the branch to create in the tree

Returns: The usual StatusCode values

Implements CP::TreeBranchHelpers::IObjectProcessor.

Definition at line 425 of file RNtupleFieldHelpers.cxx.

                                                                    {
        ATH_MSG_ERROR("ContainerProcessor::addBranch for TTree should not be called");
        return StatusCode::FAILURE;
    }

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

                                      {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg();
#else // not XAOD_STANDALONE
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msg() [2/2]

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

inherited

The standard message stream.

Parameters

lvl	The 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.

                                                          {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg( lvl );
#else // not XAOD_STANDALONE
      m_msg << lvl;
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msgLvl()

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

inherited

Test the output level of the object.

Parameters

lvl	The 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.

                                                       {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msgLvl( lvl );
#else // not XAOD_STANDALONE
      return m_msg.msgLevel( lvl );
#endif // not XAOD_STANDALONE
   }

◆ operator=()

ContainerProcessor & CP::RNtupleFieldHelpers::ContainerProcessor::operator= ( const ContainerProcessor & )

delete

◆ retrieveProcess()

StatusCode CP::RNtupleFieldHelpers::ContainerProcessor::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.

Definition at line 432 of file RNtupleFieldHelpers.cxx.

                                                                        {
        // Retrieve the container:
        static const bool ALLOW_MISSING = false;
        const TClass* cl = nullptr;
        const SG::AuxVectorBase* vec = getVector( m_sgName,
                                                evtStore,
                                                ALLOW_MISSING, cl, msg() ); 
 
        if( ! vec ) {
            ATH_MSG_ERROR( "Failed to retrieve container \""
                            << m_sgName << "\"" );
            return StatusCode::FAILURE;
        }
        const SG::AuxVectorBase& container = *vec;
        if( ! m_collProxy ) {
 
                // Get the collection proxy from the dictionary.
                m_collProxy = cl->GetCollectionProxy();
                if( ! m_collProxy ) {
                    ATH_MSG_ERROR( "No collection proxy provided by type: "
                                << cl->GetName() );
                    return StatusCode::FAILURE;
                }
 
                // Get the offset that one needs to use to get from the element
                // pointers to SG::AuxElement pointers.
                static const TClass* const auxElementClass =
                    TClass::GetClass( typeid( SG::AuxElement ) );
                m_auxElementOffset =
                    m_collProxy->GetValueClass()->GetBaseClassOffset( auxElementClass );
                if( m_auxElementOffset < 0 ) {
                    ATH_MSG_ERROR( "Vector element type \""
                                << m_collProxy->GetValueClass()->GetName()
                                << "\" doesn't seem to inherit from \""
                                << auxElementClass->GetName() << "\"" );
                    return StatusCode::FAILURE;
                }
        }
 
        void* cPtr =
            const_cast< void* >( static_cast< const void* >( &container ) );
        TVirtualCollectionProxy::TPushPop helper( m_collProxy, cPtr );
        const UInt_t cSize = m_collProxy->Size();
 
        for( auto& p : m_fields ) {
            ATH_CHECK( p->resize( cSize, msg() ) );
        }
 
        for (UInt_t i = 0; i < cSize; ++i) {
            char* elPtr = static_cast< char* >( m_collProxy->At( i ) );
            if( ! elPtr ) {
                ATH_MSG_ERROR( "Failed to get element " << i << " from container" );
                return StatusCode::FAILURE;
            }
            const SG::AuxElement* element =
                reinterpret_cast< const SG::AuxElement* >( elPtr +
                                                        m_auxElementOffset );
 
            for ( auto& p : m_fields ) {
                ATH_CHECK( p->process( *element, i, msg() ) );
            }
        }
        return StatusCode::SUCCESS;
    }

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

int CP::RNtupleFieldHelpers::ContainerProcessor::m_auxElementOffset = -1

private

Definition at line 168 of file RNtupleFieldHelpers.h.

◆ m_collProxy

TVirtualCollectionProxy* CP::RNtupleFieldHelpers::ContainerProcessor::m_collProxy = nullptr

private

Definition at line 167 of file RNtupleFieldHelpers.h.

◆ m_fields

std::vector< std::unique_ptr<ContainerFieldProcessor> > CP::RNtupleFieldHelpers::ContainerProcessor::m_fields

private

Definition at line 166 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::ContainerProcessor::m_sgName

private

Definition at line 165 of file RNtupleFieldHelpers.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ContainerProcessor() [1/2]

◆ ~ContainerProcessor()

◆ ContainerProcessor() [2/2]

Member Function Documentation

◆ addBranch() [1/2]

◆ addBranch() [2/2]

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator=()

◆ retrieveProcess()

◆ setLevel()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_auxElementOffset

◆ m_collProxy

◆ m_fields

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_sgName