This is the AthenaRoot version of AthenaServices/AthenaOutputStreamTool. More...

#include <RootOutputStreamTool.h>

Inheritance diagram for Athena::RootOutputStreamTool:

Collaboration diagram for Athena::RootOutputStreamTool:

Public Types
typedef std::pair< std::string, std::string >	TypeKeyPair
	Stream out objects. More...

typedef std::vector< TypeKeyPair >	TypeKeyPairs

typedef std::vector< DataObject * >	DataObjectVec
	Stream out a vector of objects Must convert to DataObject, e.g. More...

Public Member Functions
	RootOutputStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard AlgTool Constructor. More...

virtual	~RootOutputStreamTool ()
	Destructor. More...

StatusCode	initialize ()
	Gaudi AlgTool Interface method implementations: More...

StatusCode	finalize ()

StatusCode	connectServices (const std::string &dataStore, const std::string &cnvSvc, bool extendProvenenceRecord)
	Specify which data store and conversion service to use and whether to extend provenence Only use if one wants to override jobOptions. More...

StatusCode	connectOutput (const std::string &outputName)
	Connect to the output stream Must connectOutput BEFORE streaming Only specify "outputName" if one wants to override jobOptions. More...

StatusCode	commitOutput (bool doCommit=false)
	Commit the output stream after having streamed out objects Must commitOutput AFTER streaming. More...

StatusCode	finalizeOutput ()
	Finalize the output stream after the last commit, e.g. More...

StatusCode	streamObjects (const IAthenaOutputStreamTool::TypeKeyPairs &typeKeys, const std::string &outputName="")
	Stream out objects. More...

StatusCode	streamObjects (const IAthenaOutputStreamTool::DataObjectVec &dataObjects, const std::string &outputName="")
	Stream out a vector of objects Must convert to DataObject, e.g. More...

StatusCode	fillObjectRefs (const IAthenaOutputStreamTool::DataObjectVec &dataObjects)
	Fill refs of an object - done as second iteration over objects, after streamObject. More...

StatusCode	getInputItemList (SG::IFolder *m_p2BWrittenFromTool)
	Get ItemList from the OutputStreamTool (e.g. all input objects) More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

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

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Gaudi boilerplate. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	RootOutputStreamTool ()
	Default constructor: More...

	RootOutputStreamTool (const RootOutputStreamTool &)

RootOutputStreamTool &	operator= (const RootOutputStreamTool &)

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
ServiceHandle< ::StoreGateSvc >	m_storeSvc
	ServiceHandle to the data store service. More...

ServiceHandle< ::IConversionSvc >	m_conversionSvc
	ServiceHandle to the data conversion service. More...

ServiceHandle< ::IClassIDSvc >	m_clidSvc
	ServiceHandle to clid service. More...

std::string	m_outputName
	Name of the output file. More...

std::string	m_treeName
	Name of the output tuple. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

This is the AthenaRoot version of AthenaServices/AthenaOutputStreamTool.

Definition at line 33 of file RootOutputStreamTool.h.

Member Typedef Documentation

◆ DataObjectVec

typedef std::vector< DataObject* > IAthenaOutputStreamTool::DataObjectVec

inherited

Stream out a vector of objects Must convert to DataObject, e.g.

#include "AthenaKernel/StorableConversions.h" T* obj = xxx; DataObject* dataObject = SG::asStorable(obj);

Definition at line 107 of file IAthenaOutputStreamTool.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ TypeKeyPair

typedef std::pair<std::string, std::string> IAthenaOutputStreamTool::TypeKeyPair

inherited

Stream out objects.

Provide vector of typeName/key pairs. If key is empty, assumes only one object and this will fail if there is more than one

Definition at line 98 of file IAthenaOutputStreamTool.h.

◆ TypeKeyPairs

typedef std::vector< TypeKeyPair > IAthenaOutputStreamTool::TypeKeyPairs

inherited

Definition at line 99 of file IAthenaOutputStreamTool.h.

Constructor & Destructor Documentation

◆ RootOutputStreamTool() [1/3]

Athena::RootOutputStreamTool::RootOutputStreamTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard AlgTool Constructor.

Definition at line 33 of file RootOutputStreamTool.cxx.

                                                                                                                  : 
     ::AthAlgTool(type, name, parent),
     m_storeSvc("StoreGateSvc", name),
     m_conversionSvc("Athena::RootCnvSvc/AthenaRootCnvSvc", name),
     m_clidSvc("ClassIDSvc", name) {
   // Declare IAthenaOutputStreamTool interface
   declareInterface<IAthenaOutputStreamTool>(this);
   // Properties
   declareProperty("Store", m_storeSvc, "Store from which to stream out event data");
   declareProperty("TreeName", m_treeName = "CollectionTree", "Name of the output event tree");
   declareProperty("OutputFile", m_outputName, "Name of the output file");
 }

◆ ~RootOutputStreamTool()

Athena::RootOutputStreamTool::~RootOutputStreamTool ( )

virtual

Destructor.

Definition at line 46 of file RootOutputStreamTool.cxx.

46 {

47 }

◆ RootOutputStreamTool() [2/3]

Athena::RootOutputStreamTool::RootOutputStreamTool ( )

private

Default constructor:

◆ RootOutputStreamTool() [3/3]

Athena::RootOutputStreamTool::RootOutputStreamTool ( const RootOutputStreamTool & )

private

Member Function Documentation

◆ commitOutput()

StatusCode Athena::RootOutputStreamTool::commitOutput ( bool doCommit = false )

virtual

Commit the output stream after having streamed out objects Must commitOutput AFTER streaming.

Implements IAthenaOutputStreamTool.

Definition at line 112 of file RootOutputStreamTool.cxx.

                                                    {
   ATH_MSG_VERBOSE("commitOutput");
   if (m_outputName.empty()) {
     ATH_MSG_ERROR("Unable to commit, no output connected.");
     return StatusCode::FAILURE;
   }
   // Connect the output file to the service
   if (!m_conversionSvc->commitOutput(m_outputName, false).isSuccess()) {
     ATH_MSG_ERROR("Unable to commit output " << m_outputName);
     return StatusCode::FAILURE;
   } else {
     ATH_MSG_DEBUG("Committed: " << m_outputName);
   }
   m_outputName.clear();
   return StatusCode::SUCCESS;
 }

◆ connectOutput()

StatusCode Athena::RootOutputStreamTool::connectOutput ( const std::string & outputName )

virtual

Connect to the output stream Must connectOutput BEFORE streaming Only specify "outputName" if one wants to override jobOptions.

Implements IAthenaOutputStreamTool.

Definition at line 94 of file RootOutputStreamTool.cxx.

                                                                           {
   ATH_MSG_VERBOSE("connectOutput outputName = [" << outputName <<"]");
   // Set output file name property
   if (!outputName.empty()) {
     m_outputName = outputName;
   } else {
     return StatusCode::FAILURE;
   }
   // Connect the output file to the service
   if (!m_conversionSvc->connectOutput(m_outputName + "(" + m_treeName + ")", "recreate").isSuccess()) {
     ATH_MSG_ERROR("Unable to connect output " << m_outputName);
     return StatusCode::FAILURE;
   } else {
     ATH_MSG_DEBUG("Connected to " << m_outputName);
   }
   return StatusCode::SUCCESS;
 }

◆ connectServices()

StatusCode Athena::RootOutputStreamTool::connectServices	(	const std::string &	dataStore,
		const std::string &	cnvSvc,
		bool	extendProvenenceRecord
	)

virtual

Specify which data store and conversion service to use and whether to extend provenence Only use if one wants to override jobOptions.

Implements IAthenaOutputStreamTool.

Definition at line 80 of file RootOutputStreamTool.cxx.

                                                                                                                                  {
   ATH_MSG_VERBOSE("connectServices dataStore = " << dataStore << ", cnvSvc = " << cnvSvc << ", extendProv = " << extendProvenenceRecord);
   // Release the old data store service
   if (m_storeSvc != 0) {
     if (!m_storeSvc.release().isSuccess()) {
       ATH_MSG_WARNING("Could not release " << m_storeSvc.type() << " store.");
     }
   }
   m_storeSvc = ServiceHandle<StoreGateSvc>(dataStore, this->name());
   // Get the data store service
   ATH_CHECK(m_storeSvc.retrieve());
   return StatusCode::SUCCESS;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ fillObjectRefs()

StatusCode Athena::RootOutputStreamTool::fillObjectRefs ( const IAthenaOutputStreamTool::DataObjectVec & dataObjects )

Fill refs of an object - done as second iteration over objects, after streamObject.

Definition at line 223 of file RootOutputStreamTool.cxx.

                                                                       {
   ATH_MSG_VERBOSE("fillObjectRefs");
   return StatusCode::SUCCESS;
 }

◆ finalize()

StatusCode Athena::RootOutputStreamTool::finalize ( )

Definition at line 62 of file RootOutputStreamTool.cxx.

                                           {
   // Release the data store service
   if (m_storeSvc != 0) {
     if (!m_storeSvc.release().isSuccess()) {
       ATH_MSG_WARNING("Could not release " << m_storeSvc.type() << " store.");
     }
   }
   // Release the conversion service
   if (!m_conversionSvc.release().isSuccess()) {
     ATH_MSG_WARNING("Cannot release conversion service.");
   }
   // Release the ClassID service
   if (!m_clidSvc.release().isSuccess()) {
     ATH_MSG_WARNING("Cannot release ClassID service.");
   }
   return ::AthAlgTool::finalize();
 }

◆ finalizeOutput()

StatusCode Athena::RootOutputStreamTool::finalizeOutput ( )

virtual

Finalize the output stream after the last commit, e.g.

in finalize

Implements IAthenaOutputStreamTool.

Definition at line 129 of file RootOutputStreamTool.cxx.

                                                 {
   ATH_MSG_VERBOSE("finalizeOutput");
   return StatusCode::SUCCESS;
 }

◆ getInputItemList()

StatusCode Athena::RootOutputStreamTool::getInputItemList ( SG::IFolder * m_p2BWrittenFromTool )

virtual

Get ItemList from the OutputStreamTool (e.g. all input objects)

Implements IAthenaOutputStreamTool.

Definition at line 228 of file RootOutputStreamTool.cxx.

                                                               {
   ATH_MSG_VERBOSE("getInputItemList");
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode Athena::RootOutputStreamTool::initialize ( )

Gaudi AlgTool Interface method implementations:

Definition at line 49 of file RootOutputStreamTool.cxx.

                                             {
   ATH_MSG_INFO("Initializing " << name());
   if (!::AthAlgTool::initialize().isSuccess()) {
     ATH_MSG_FATAL("Cannot initialize AlgTool base class.");
     return StatusCode::FAILURE;
   }
   // Get the ClassID service
   ATH_CHECK(m_clidSvc.retrieve());
   // Get the conversion service
   ATH_CHECK(m_conversionSvc.retrieve());
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & IAthenaOutputStreamTool::interfaceID ( )

inlinestaticinherited

Gaudi boilerplate.

Definition at line 119 of file IAthenaOutputStreamTool.h.

                                      {
   static const InterfaceID IID("IAthenaOutputStreamTool", 1, 0);
   return IID;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ operator=()

RootOutputStreamTool& Athena::RootOutputStreamTool::operator= ( const RootOutputStreamTool & )

private

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ streamObjects() [1/2]

StatusCode Athena::RootOutputStreamTool::streamObjects	(	const IAthenaOutputStreamTool::DataObjectVec &	dataObjects,
		const std::string &	outputName = `""`
	)

virtual

Stream out a vector of objects Must convert to DataObject, e.g.

#include "AthenaKernel/StorableConversions.h" T* obj = xxx; DataObject* dataObject = SG::asStorable(obj);

Implements IAthenaOutputStreamTool.

Definition at line 173 of file RootOutputStreamTool.cxx.

     {
   ATH_MSG_VERBOSE("streamObjects(dobjs)");
   if (m_outputName.empty()) {
     ATH_MSG_ERROR("Unable to commit, no output connected.");
     return StatusCode::FAILURE;
   }
   ATH_MSG_VERBOSE("streaming out... [" << m_conversionSvc.typeAndName() << "]");
   std::set<DataObject*> written;
   for (std::vector<DataObject*>::const_iterator doIter = dataObjects.begin(), doLast = dataObjects.end();
       doIter != doLast; ++doIter) {
     ATH_MSG_VERBOSE(" --> [" << (*doIter)->clID() << "/" << (*doIter)->name() << "]...");
     // Do not stream out same object twice
     if (written.find(*doIter) != written.end()) {
       // Print warning and skip
       ATH_MSG_DEBUG("Trying to write DataObject twice (clid/key): " << (*doIter)->clID() << ", " << (*doIter)->name());
       ATH_MSG_DEBUG("    Skipping this one.");
     } else {
       written.insert(*doIter);
       // Write object
       IOpaqueAddress* addr = 0;
       if ((m_conversionSvc->createRep(*doIter, addr)).isSuccess()) {
         IRegistry* ireg = (*doIter)->registry();
         // FIXME: that's a wild hack to handle RootBranchAddress's stickyness.
         // if the transient address already has a RootBranchAddress (ie: it was
         // read from a d3pd-file) calling setAddress will invalidate the
         // previous RBA which will screw things up the next time around.
         // The real fix would probably involve changing a bit the logic either
         // in convsvc::createRep above, or -rather- have the side effect of
         // properly setting up the RootConnection (in createRep) be explicitly
         // written somewhere. (here?)
         if (dynamic_cast<RootBranchAddress*>(ireg->address())) {
           delete addr; addr = 0;
         } else {
           ireg->setAddress(addr);
         }
         // SG::DataProxy* proxy = dynamic_cast<SG::DataProxy*>((*doIter)->registry());
         // if (!proxy) {
         //   ATH_MSG_WARNING("Could cast DataObject " 
         //                   << (*doIter)->clID() << " " << (*doIter)->name());
         // }
       } else {
         ATH_MSG_ERROR("Could not create Rep for DataObject (clid/key): " << (*doIter)->clID() << ", " << (*doIter)->name());
         return StatusCode::FAILURE;
       }
     }
   }
   return StatusCode::SUCCESS;
 }

◆ streamObjects() [2/2]

StatusCode Athena::RootOutputStreamTool::streamObjects	(	const IAthenaOutputStreamTool::TypeKeyPairs &	typeKeys,
		const std::string &	outputName = `""`
	)

virtual

Stream out objects.

Provide vector of typeName/key pairs. If key is empty, assumes only one object and this will fail if there is more than one

Implements IAthenaOutputStreamTool.

Definition at line 134 of file RootOutputStreamTool.cxx.

                                                                                                                                {
   ATH_MSG_VERBOSE("streamObjects(type/keys)...");
   // Now iterate over the type/key pairs and stream out each object
   std::vector<DataObject*> dataObjects;
   dataObjects.reserve(typeKeys.size());
   for (IAthenaOutputStreamTool::TypeKeyPairs::const_iterator first = typeKeys.begin(), last = typeKeys.end();
       first != last; ++first) {
     const std::string& type = (*first).first;
     const std::string& key = (*first).second;
     // Find the clid for type name from the classIDSvc
     CLID clid = 0;
     if (!m_clidSvc->getIDOfTypeName(type, clid).isSuccess()) {
       ATH_MSG_ERROR("Could not get clid for typeName " << type);
       return StatusCode::FAILURE;
     }
     DataObject* dObj = 0;
     // Two options: no key or explicit key
     if (key.empty()) {
       ATH_MSG_DEBUG("Get data object with no key");
       // Get DataObject without key
       dObj = m_storeSvc->accessData(clid);
     } else {
       ATH_MSG_DEBUG("Get data object with key");
       // Get DataObjects with key
       dObj = m_storeSvc->accessData(clid, key);
     }
     if (dObj == 0) {
       // No object - print warning and continue with next object
       ATH_MSG_WARNING("No object found for type " << type << " key " << key);
       continue;
     } else {
       ATH_MSG_DEBUG("Found object for type " << type << " key " << key);
     }
     // Save the dObj
     dataObjects.push_back(dObj);
   }
   return this->streamObjects(dataObjects, outputName);
 }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_clidSvc

ServiceHandle< ::IClassIDSvc> Athena::RootOutputStreamTool::m_clidSvc

private

ServiceHandle to clid service.

Definition at line 93 of file RootOutputStreamTool.h.

◆ m_conversionSvc

ServiceHandle< ::IConversionSvc> Athena::RootOutputStreamTool::m_conversionSvc

private

ServiceHandle to the data conversion service.

Definition at line 91 of file RootOutputStreamTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_outputName

std::string Athena::RootOutputStreamTool::m_outputName

private

Name of the output file.

Definition at line 96 of file RootOutputStreamTool.h.

◆ m_storeSvc

ServiceHandle< ::StoreGateSvc> Athena::RootOutputStreamTool::m_storeSvc

private

ServiceHandle to the data store service.

Definition at line 89 of file RootOutputStreamTool.h.

◆ m_treeName

std::string Athena::RootOutputStreamTool::m_treeName

private

Name of the output tuple.

Definition at line 99 of file RootOutputStreamTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataObjectVec

◆ StoreGateSvc_t

◆ TypeKeyPair

◆ TypeKeyPairs

Constructor & Destructor Documentation

◆ RootOutputStreamTool() [1/3]

◆ ~RootOutputStreamTool()

◆ RootOutputStreamTool() [2/3]

◆ RootOutputStreamTool() [3/3]

Member Function Documentation

◆ commitOutput()

◆ connectOutput()

◆ connectServices()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ fillObjectRefs()

◆ finalize()

◆ finalizeOutput()

◆ getInputItemList()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator=()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ streamObjects() [1/2]

◆ streamObjects() [2/2]

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_clidSvc

◆ m_conversionSvc

◆ m_detStore

◆ m_evtStore

◆ m_outputName

◆ m_storeSvc

◆ m_treeName

◆ m_varHandleArraysDeclared

◆ m_vhka