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

#include <RootOutputStreamTool.h>

Inheritance diagram for Athena::RootOutputStreamTool:

Collaboration diagram for Athena::RootOutputStreamTool:

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)

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

	RootOutputStreamTool (const RootOutputStreamTool &)

RootOutputStreamTool &	operator= (const RootOutputStreamTool &)

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

Detailed Description

This is the AthenaRoot version of AthenaServices/AthenaOutputStreamTool.

Definition at line 33 of file RootOutputStreamTool.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.

                                                                                                                  : 
     base_class(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 )

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

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 )

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

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
	)

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

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;
 }

◆ 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 ( )

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

in finalize

Definition at line 129 of file RootOutputStreamTool.cxx.

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

◆ getInputItemList()

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

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;
 }

◆ operator=()

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

private

◆ streamObjects() [1/2]

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

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

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

◆ streamObjects() [2/2]

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

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 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);
 }

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_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.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RootOutputStreamTool() [1/3]

◆ ~RootOutputStreamTool()

◆ RootOutputStreamTool() [2/3]

◆ RootOutputStreamTool() [3/3]

Member Function Documentation

◆ commitOutput()

◆ connectOutput()

◆ connectServices()

◆ fillObjectRefs()

◆ finalize()

◆ finalizeOutput()

◆ getInputItemList()

◆ initialize()

◆ operator=()

◆ streamObjects() [1/2]

◆ streamObjects() [2/2]

Member Data Documentation

◆ m_clidSvc

◆ m_conversionSvc

◆ m_outputName

◆ m_storeSvc

◆ m_treeName