Gaudi::details::BranchWrapper Struct Reference

Encapsulates a branch within a ROOT TTree, managing the data and interaction with the TTree. More...

#include </builds/gaudi/Gaudi/GaudiUtils/include/Gaudi/details/BranchWrapper.h>

Collaboration diagram for Gaudi::details::BranchWrapper:

Public Member Functions
	BranchWrapper (const gsl::not_null< TTree * > tree, const std::string &className, const std::string &branchName, const std::string &location, const Gaudi::Algorithm &algRef)
void	setDataPtr (void const *dataPtr)
void	setBranchData (const gsl::not_null< DataObject * > pObj)
std::string	getLocation () const
std::string	getClassName () const

Private Attributes
void const *	m_dataBuffer = nullptr
AnyDataWrapperBase *	baseWrapper = nullptr
TBranch *	m_branch = nullptr
std::string	m_className
std::string	m_branchName
std::string	m_location
const Gaudi::Algorithm &	m_algRef
void(*	setBranchAddress )(gsl::not_null< TBranch * >, const void **)

Detailed Description

Encapsulates a branch within a ROOT TTree, managing the data and interaction with the TTree.

Definition at line 25 of file BranchWrapper.h.

Constructor & Destructor Documentation

BranchWrapper()

Gaudi::details::BranchWrapper::BranchWrapper	(	const gsl::not_null< TTree * >	tree,
		const std::string &	className,
		const std::string &	branchName,
		const std::string &	location,
		const Gaudi::Algorithm &	algRef
	)

Definition at line 35 of file BranchWrapper.cpp.

      : m_className( className ), m_branchName( branchName ), m_location( location ), m_algRef( algRef ) {
    auto leafListTag = getLeafListForType( m_className );
    if ( !leafListTag.empty() ) {
      // Create a branch for fundamental types using the leaflist
      m_branch         = tree->Branch( m_branchName.c_str(), &m_dataBuffer,
                                       ( fmt::format( "{}/{}", m_className, leafListTag ) ).c_str() );
      setBranchAddress = []( gsl::not_null<TBranch*> br, const void** wrappedDataPtr ) {
        br->SetAddress( const_cast<void*>( *wrappedDataPtr ) );
      };
 
    } else if ( TClass::GetClass( m_className.c_str() ) ) {
      // Create a branch for object types using the classname string
      m_branch         = tree->Branch( m_branchName.c_str(), m_className.c_str(), &m_dataBuffer );
      setBranchAddress = []( gsl::not_null<TBranch*> br, const void** wrappedDataPtr ) {
        br->SetAddress( wrappedDataPtr );
      };
 
    } else {
      throw GaudiException( fmt::format( "Cannot create branch {} for unknown class: {}. Provide a dictionary please.",
                                         m_branchName, m_className ),
                            m_algRef.name(), StatusCode::FAILURE );
    }
 
    if ( !m_branch ) {
      throw GaudiException( fmt::format( "Failed to create branch {} for type {}.", m_branchName, m_className ),
                            m_algRef.name(), StatusCode::FAILURE );
    }
  }

Member Function Documentation

getClassName()

std::string Gaudi::details::BranchWrapper::getClassName

(

)

const

Definition at line 89 of file BranchWrapper.cpp.

{ return m_className; }

getLocation()

std::string Gaudi::details::BranchWrapper::getLocation

(

)

const

Definition at line 87 of file BranchWrapper.cpp.

{ return m_location; }

setBranchData()

void Gaudi::details::BranchWrapper::setBranchData

(

const gsl::not_null< DataObject * >

pObj

)

Definition at line 76 of file BranchWrapper.cpp.

                                                                         {
    baseWrapper = dynamic_cast<AnyDataWrapperBase*>( pObj.get() );
    if ( !baseWrapper ) {
      throw GaudiException( "Failed to cast DataObject to AnyDataWrapperBase type.", m_algRef.name(),
                            StatusCode::FAILURE );
    }
 
    m_dataBuffer = baseWrapper->payload();
    setBranchAddress( m_branch, &m_dataBuffer );
  }

setDataPtr()

void Gaudi::details::BranchWrapper::setDataPtr

(

void const *

dataPtr

)

Definition at line 69 of file BranchWrapper.cpp.

                                                      {
    m_dataBuffer = dataPtr;
    setBranchAddress( m_branch, &m_dataBuffer );
  }

Member Data Documentation

baseWrapper

AnyDataWrapperBase* Gaudi::details::BranchWrapper::baseWrapper = nullptr

private

Definition at line 29 of file BranchWrapper.h.

m_algRef

const Gaudi::Algorithm& Gaudi::details::BranchWrapper::m_algRef

private

Definition at line 34 of file BranchWrapper.h.

m_branch

TBranch* Gaudi::details::BranchWrapper::m_branch = nullptr

private

Definition at line 30 of file BranchWrapper.h.

m_branchName

std::string Gaudi::details::BranchWrapper::m_branchName

private

Definition at line 32 of file BranchWrapper.h.

m_className

std::string Gaudi::details::BranchWrapper::m_className

private

Definition at line 31 of file BranchWrapper.h.

m_dataBuffer

void const* Gaudi::details::BranchWrapper::m_dataBuffer = nullptr

private

Definition at line 28 of file BranchWrapper.h.

m_location

std::string Gaudi::details::BranchWrapper::m_location

private

Definition at line 33 of file BranchWrapper.h.

setBranchAddress

void( * Gaudi::details::BranchWrapper::setBranchAddress) (gsl::not_null< TBranch * >, const void **)

private

Definition at line 35 of file BranchWrapper.h.

---

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

• GaudiUtils/include/Gaudi/details/BranchWrapper.h
• GaudiUtils/src/Lib/BranchWrapper.cpp