A Gaudi algorithm for writing data of any type from N locations in the event store to a TTree. More...

Inheritance diagram for Gaudi::NTuple::GenericWriter:

[legend]

Collaboration diagram for Gaudi::NTuple::GenericWriter:

[legend]

Public Member Functions
	GenericWriter (const std::string &n, ISvcLocator *l)

StatusCode	initialize () override

StatusCode	execute (const EventContext &) const override

StatusCode	finalize () override

void	createBranches (const DataObjIDColl &extraInputs)

size_t	getBranchWrappersSize () const

std::unordered_set< std::string >	getBranchesClassNames () const

void	setTree (TTree *tree)

Public Member Functions inherited from Gaudi::Algorithm
	Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
	Constructor.

StatusCode	sysStart () override
	Reinitialization method invoked by the framework.

StatusCode	sysInitialize () override
	Initialization method invoked by the framework.

StatusCode	sysReinitialize () override
	Reinitialization method invoked by the framework.

StatusCode	sysRestart () override
	Restart method invoked by the framework.

StatusCode	sysExecute (const EventContext &ctx) override
	The actions to be performed by the algorithm on an event.

StatusCode	sysStop () override
	System stop.

StatusCode	sysFinalize () override
	System finalization.

const std::string &	name () const override
	The identifying name of the algorithm object.

const Gaudi::StringKey &	nameKey () const override

const std::string &	type () const override
	The type of the algorithm object.

void	setType (std::string type) override

const std::string &	version () const override

unsigned int	index () const override

StatusCode	configure () override
	Dummy implementation of IStateful::configure() method.

StatusCode	terminate () override
	Dummy implementation of IStateful::terminate() method.

StatusCode	initialize () override
	the default (empty) implementation of IStateful::initialize() method

StatusCode	start () override
	the default (empty) implementation of IStateful::start() method

StatusCode	stop () override
	the default (empty) implementation of IStateful::stop() method

StatusCode	finalize () override
	the default (empty) implementation of IStateful::finalize() method

StatusCode	reinitialize () override
	the default (empty) implementation of IStateful::reinitialize() method

StatusCode	restart () override
	the default (empty) implementation of IStateful::restart() method

Gaudi::StateMachine::State	FSMState () const override
	returns the current state of the algorithm

Gaudi::StateMachine::State	targetFSMState () const override
	returns the state the algorithm will be in after the ongoing transition

bool	isEnabled () const override
	Is this algorithm enabled or disabled?

bool	isSequence () const override
	Are we a Sequence?

unsigned int	errorCount () const
	Get the number of failures of the algorithm.

SmartIF< IService >	service (std::string_view name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name")

template<class T>
SmartIF< T >	service (std::string_view name, bool createIf=true, bool quiet=false) const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present.

SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service.

SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service.

SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service.

SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc

SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service.

SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service.

SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service.

SmartIF< IRndmGenSvc > &	randSvc () const
	The standard RandomGen service, Return a pointer to the service if present.

SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present.

SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service.

SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service

SmartIF< ITimelineSvc > &	timelineSvc () const

SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator.

SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator

SmartIF< IHiveWhiteBoard > &	whiteboard () const

SmartIF< IAlgExecStateSvc > &	algExecStateSvc () const

bool	registerContext () const
	register for Algorithm Context Service?

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service.

template<class T>
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information.

void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case)

void	acceptDHVisitor (IDataHandleVisitor *) const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

bool	isAsynchronous () const

void	setAsynchronous (bool value)

unsigned int	cardinality () const override
	Return the cardinality.

const std::vector< std::string > &	neededResources () const override

AlgExecStateRef	execState (const EventContext &ctx) const override
	get the AlgExecStateRef of current algorithm Actually a small wrapper around it, thus the plain object return type

std::ostream &	toControlFlowExpression (std::ostream &os) const override
	Produce string represention of the control flow expression.

Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override

std::vector< Gaudi::DataHandle * >	outputHandles () const override

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

void	declare (Gaudi::DataHandle &handle) override

void	renounce (Gaudi::DataHandle &handle) override

bool	renounceInput (const DataObjID &id) override

const DataObjIDColl &	inputDataObjs () const override

const DataObjIDColl &	outputDataObjs () const override

void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override

Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Private Attributes
Gaudi::Property< std::string >	m_fileId

Gaudi::Property< std::string >	m_ntupleTname

std::shared_ptr< TFile >	m_file = nullptr

TTree *	m_tree = nullptr

IDataProviderSvc *	m_eventSvc = nullptr

Gaudi::Interfaces::IFileSvc *	m_fileSvc = nullptr

std::mutex	m_mtx

std::vector< Gaudi::details::BranchWrapper >	m_branchWrappers {}

Additional Inherited Members
Public Types inherited from Gaudi::Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm (const std::string &, ISvcLocator )>	Factory

Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Public Attributes inherited from Gaudi::Algorithm
friend	AlgorithmManager

Protected Member Functions inherited from Gaudi::Algorithm
std::vector< IAlgTool * > &	tools ()

bool	isInitialized () const override
	Has the Algorithm already been initialized?

bool	isFinalized () const override
	Has the Algorithm already been finalized?

void	setIndex (const unsigned int &idx) override
	set instantiation index of Alg

bool	isReEntrant () const override

Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this

Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Gaudi::Algorithm
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles.

Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs

DataObjIDColl	m_outputDataObjs

Detailed Description

A Gaudi algorithm for writing data of any type from N locations in the event store to a TTree.

This class allows users to write data from various locations within the event store into a ROOT TTree structure dynamically creating branches leveraging ROOT's dynamic typing and I/O capabilities to support a range of data types.

Definition at line 48 of file GenericNTupleWriter.cpp.

Constructor & Destructor Documentation

◆ GenericWriter()

Gaudi::NTuple::GenericWriter::GenericWriter	(	const std::string &	n,
		ISvcLocator *	l )

inline

Definition at line 50 of file GenericNTupleWriter.cpp.

51 : Algorithm( n, l ), m_fileId( this, "OutputFile", "NTuple", "Identifier for the TFile to write to." ) {}

Gaudi::Algorithm::Algorithm

Algorithm(std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)

Constructor.

Definition Algorithm.h:98

Gaudi::NTuple::GenericWriter::m_fileId

Gaudi::Property< std::string > m_fileId

Definition GenericNTupleWriter.cpp:143

Member Function Documentation

◆ createBranches()

void Gaudi::NTuple::GenericWriter::createBranches ( const DataObjIDColl & extraInputs )

inline

Definition at line 122 of file GenericNTupleWriter.cpp.

                                                            {
      m_branchWrappers.reserve( m_branchWrappers.size() + extraInputs.size() );
      for ( const auto& dep : extraInputs ) {
        auto typeName   = getTypeName( dep.className() );
        auto branchName = getNameFromLoc( dep.key() );
        m_branchWrappers.emplace_back( m_tree, typeName, branchName, dep.key(), name() );
      }
    }

◆ execute()

StatusCode Gaudi::NTuple::GenericWriter::execute ( const EventContext & ) const

inlineoverride

Definition at line 88 of file GenericNTupleWriter.cpp.

                                                             {
      std::vector<DataObject*> pObjs( m_branchWrappers.size(), nullptr );
 
      for ( std::size_t i = 0; const auto& wrapper : m_branchWrappers ) {
        m_eventSvc->retrieveObject( wrapper.getLocation(), pObjs[i++] )
            .orThrow( fmt::format( "Failed to retrieve object for location '{}'. Ensure the location is correct and "
                                   "the object exists.",
                                   wrapper.getLocation() ),
                      name() );
      }
 
      {
        std::scoped_lock lock{ m_mtx };
        for ( std::size_t i = 0; auto& wrapper : m_branchWrappers ) { wrapper.setBranchData( pObjs[i++] ); }
        m_tree->Fill();
      }
 
      return StatusCode::SUCCESS;
    }

◆ finalize()

StatusCode Gaudi::NTuple::GenericWriter::finalize ( )

inlineoverride

Definition at line 109 of file GenericNTupleWriter.cpp.

                                   {
      m_file->cd();
      if ( m_tree->Write() <= 0 ) {
        error() << "Failed to write TTree to ROOT file." << endmsg;
        return StatusCode::FAILURE;
      }
      m_tree = nullptr;
      info() << "TTree written to ROOT file. File closed." << endmsg;
 
      return Gaudi::Algorithm::finalize();
    }

◆ getBranchesClassNames()

std::unordered_set< std::string > Gaudi::NTuple::GenericWriter::getBranchesClassNames ( ) const

inline

Definition at line 134 of file GenericNTupleWriter.cpp.

                                                              {
      std::unordered_set<std::string> classNames;
      for ( auto& wrapper : m_branchWrappers ) { classNames.insert( wrapper.getClassName() ); }
      return classNames;
    }

◆ getBranchWrappersSize()

size_t Gaudi::NTuple::GenericWriter::getBranchWrappersSize ( ) const

inline

Definition at line 132 of file GenericNTupleWriter.cpp.

132{ return m_branchWrappers.size(); }

◆ initialize()

StatusCode Gaudi::NTuple::GenericWriter::initialize ( )

inlineoverride

Definition at line 54 of file GenericNTupleWriter.cpp.

                                     {
      return Gaudi::Algorithm::initialize().andThen( [this]() {
        if ( m_ntupleTname.empty() ) m_ntupleTname = name();
 
        const auto& extraInputs = extraInputDeps();
        if ( extraInputs.empty() ) {
          error() << "No extra inputs locations specified. Please define extra inputs for the NTuple writer." << endmsg;
          return StatusCode::FAILURE;
        }
 
        m_fileSvc = service<Gaudi::Interfaces::IFileSvc>( "FileSvc" );
        if ( !m_fileSvc ) {
          error() << "Failed to retrieve FileSvc." << endmsg;
          return StatusCode::FAILURE;
        }
 
        m_file = m_fileSvc->getFile( m_fileId );
        if ( !m_file ) {
          error() << "Failed to retrieve TFile." << endmsg;
          return StatusCode::FAILURE;
        }
 
        m_tree = std::make_unique<TTree>( m_ntupleTname.value().c_str(), "Tree of GenericWriter Algorithm" ).release();
 
        createBranches( extraInputs );
 
        // eventSvc guarantees that the pointer is not null
        m_eventSvc = eventSvc();
 
        return StatusCode::SUCCESS;
      } );
    }

◆ setTree()

void Gaudi::NTuple::GenericWriter::setTree ( TTree * tree )

inline

Definition at line 140 of file GenericNTupleWriter.cpp.

140{ m_tree = tree; }

Member Data Documentation

◆ m_branchWrappers

std::vector<Gaudi::details::BranchWrapper> Gaudi::NTuple::GenericWriter::m_branchWrappers {}

mutableprivate

Definition at line 151 of file GenericNTupleWriter.cpp.

151{}; // Container for all BranchWrapper instances

◆ m_eventSvc

IDataProviderSvc* Gaudi::NTuple::GenericWriter::m_eventSvc = nullptr

private

Definition at line 148 of file GenericNTupleWriter.cpp.

◆ m_file

std::shared_ptr<TFile> Gaudi::NTuple::GenericWriter::m_file = nullptr

private

Definition at line 146 of file GenericNTupleWriter.cpp.

◆ m_fileId

Gaudi::Property<std::string> Gaudi::NTuple::GenericWriter::m_fileId

private

Definition at line 143 of file GenericNTupleWriter.cpp.

◆ m_fileSvc

Gaudi::Interfaces::IFileSvc* Gaudi::NTuple::GenericWriter::m_fileSvc = nullptr

private

Definition at line 149 of file GenericNTupleWriter.cpp.

◆ m_mtx

std::mutex Gaudi::NTuple::GenericWriter::m_mtx

mutableprivate

Definition at line 150 of file GenericNTupleWriter.cpp.

◆ m_ntupleTname

Gaudi::Property<std::string> Gaudi::NTuple::GenericWriter::m_ntupleTname

private

Initial value:

{ this, "NTupleName", "",

"Name of the TTree" }

Definition at line 144 of file GenericNTupleWriter.cpp.

144 { this, "NTupleName", "",

145 "Name of the TTree" }; // Property to hold the name of the TTree

◆ m_tree

TTree* Gaudi::NTuple::GenericWriter::m_tree = nullptr

private

Definition at line 147 of file GenericNTupleWriter.cpp.

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

GaudiUtils/src/component/GenericNTupleWriter.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GenericWriter()

Member Function Documentation

◆ createBranches()

◆ execute()

◆ finalize()

◆ getBranchesClassNames()

◆ getBranchWrappersSize()

◆ initialize()

◆ setTree()

Member Data Documentation

◆ m_branchWrappers

◆ m_eventSvc

◆ m_file

◆ m_fileId

◆ m_fileSvc

◆ m_mtx

◆ m_ntupleTname

◆ m_tree