Class writing all variables from one DataVector container. More...

#include <TreeBranchHelpers.h>

Inheritance diagram for CP::TreeBranchHelpers::ContainerProcessorRegular:

Collaboration diagram for CP::TreeBranchHelpers::ContainerProcessorRegular:

Public Member Functions
	ContainerProcessorRegular (const std::string &sgName)
	Default constructor.
virtual	~ContainerProcessorRegular ()=default
	ContainerProcessorRegular (const ContainerProcessorRegular &)=delete
ContainerProcessorRegular &	operator= (const ContainerProcessorRegular &)=delete
virtual StatusCode	retrieveProcess (StoreType &evtStore) override
	retrieve and process the object
virtual StatusCode	addBranch (TTree &tree, const BranchConfig &branchConfig, OutputBranchData &outputData) override
	Add one branch to the output tree.
virtual StatusCode	addBranch (ROOT::RNTupleModel &model, const BranchConfig &branchConfig, OutputBranchData &outputData) override
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::vector< std::unique_ptr< ContainerBranchProcessor > >	m_branches
	List of branch processors set up for this xAOD object.
TVirtualCollectionProxy *	m_collProxy = nullptr
	Collection proxy used for iterating over the container.
int	m_auxElementOffset = -1
	Offset of the element type to `SG::AuxElement`.
std::string	m_sgName
	Name of the object in the event store.
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

Class writing all variables from one DataVector container.

It is designed to work with any DataVector<SG::AuxElement> type, it doesn't have to be an xAOD::IParticleContainer. But of course that is the main use case for it...

It expects an SG::AuxVectorBase object from the caller, iterates over the elements of that container using the ROOT dictionary of the type, and writes individual variables from the elements of the container using the same machinery that ElementProcessorRegular employs.

Definition at line 408 of file TreeBranchHelpers.h.

Constructor & Destructor Documentation

◆ ContainerProcessorRegular() [1/2]

CP::TreeBranchHelpers::ContainerProcessorRegular::ContainerProcessorRegular ( const std::string & sgName )

Default constructor.

We have to have a default constructor to initialise the asg::AsgMessaging base class correctly. Members of this class would not need an explicit constructor themselves.

Definition at line 880 of file TreeBranchHelpers.cxx.

    : asg::AsgMessaging( ("CP::TreeBranchHelpers::ContainerProcessorRegular/" + sgName).c_str() ),
      m_sgName(sgName) {
 
    }

◆ ~ContainerProcessorRegular()

virtual CP::TreeBranchHelpers::ContainerProcessorRegular::~ContainerProcessorRegular ( )

virtualdefault

◆ ContainerProcessorRegular() [2/2]

CP::TreeBranchHelpers::ContainerProcessorRegular::ContainerProcessorRegular ( const ContainerProcessorRegular & )

delete

Member Function Documentation

◆ addBranch() [1/2]

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

overridevirtual

Implements CP::TreeBranchHelpers::IObjectProcessor.

Definition at line 974 of file TreeBranchHelpers.cxx.

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

◆ addBranch() [2/2]

StatusCode CP::TreeBranchHelpers::ContainerProcessorRegular::addBranch	(	TTree &	tree,
		const BranchConfig &	branchConfig,
		OutputBranchData &	outputData )

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
allowMissing	Set to `true` to print an error message in case of a failure
created	Used to store if the branch was actually created

Returns: The usual StatusCode values

Implements CP::TreeBranchHelpers::IObjectProcessor.

Definition at line 963 of file TreeBranchHelpers.cxx.

                                                                                             {
 
      // Set up the new branch.
      m_branches.emplace_back(std::make_unique<ContainerBranchProcessor>());
      ATH_CHECK( m_branches.back()->setup( tree, branchConfig, outputData, msg() ) );
 
      // Return gracefully.
      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 & 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=()

ContainerProcessorRegular & CP::TreeBranchHelpers::ContainerProcessorRegular::operator= ( const ContainerProcessorRegular & )

delete

◆ retrieveProcess()

StatusCode CP::TreeBranchHelpers::ContainerProcessorRegular::retrieveProcess ( StoreType & evtStore )

overridevirtual

retrieve and process the object

Implements CP::TreeBranchHelpers::IObjectProcessor.

Definition at line 886 of file TreeBranchHelpers.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;
 
      // Get the collection proxy for the type if it's not available yet.
      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;
        }
      }
 
      // Set up the iteration over the elements of the container. In a really
      // low level / ugly way...
      void* cPtr =
        const_cast< void* >( static_cast< const void* >( &container ) );
      TVirtualCollectionProxy::TPushPop helper( m_collProxy, cPtr );
      const UInt_t cSize = m_collProxy->Size();
 
      // Tell all branch processors to resize their variables.
      for( auto& p : m_branches ) {
        ATH_CHECK( p->resize( cSize, msg() ) );
      }
 
      // Now iterate over the container.
      for( UInt_t i = 0; i < cSize; ++i ) {
 
        // Get the element.
        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 );
 
        // Execute all branch processors on this element.
        for( auto& p : m_branches ) {
            ATH_CHECK( p->process( *element, i, msg() ) );
        }
      }
 
      // Return gracefully.
      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::TreeBranchHelpers::ContainerProcessorRegular::m_auxElementOffset = -1

private

Offset of the element type to SG::AuxElement.

Definition at line 459 of file TreeBranchHelpers.h.

◆ m_branches

std::vector<std::unique_ptr<ContainerBranchProcessor> > CP::TreeBranchHelpers::ContainerProcessorRegular::m_branches

private

List of branch processors set up for this xAOD object.

Note that when we set up a branch, we tell TTree to remember a physical address in memory. To make sure that the address of the object held by the branch processors are not moved in memory after their construction, we have to use an std::list container here. std::vector would not work. (As it can relocate objects when increasing the size of the container.)

Definition at line 455 of file TreeBranchHelpers.h.

◆ m_collProxy

TVirtualCollectionProxy* CP::TreeBranchHelpers::ContainerProcessorRegular::m_collProxy = nullptr

private

Collection proxy used for iterating over the container.

Definition at line 457 of file TreeBranchHelpers.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::TreeBranchHelpers::ContainerProcessorRegular::m_sgName

private

Name of the object in the event store.

Definition at line 462 of file TreeBranchHelpers.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

◆ ContainerProcessorRegular() [1/2]

◆ ~ContainerProcessorRegular()

◆ ContainerProcessorRegular() [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_branches

◆ m_collProxy

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_sgName