A small to stream Data I/O. More...

#include </builds/gaudi/Gaudi/GaudiCommonSvc/src/PersistencySvc/OutputStream.h>

Inheritance diagram for OutputStream:

[legend]

Collaboration diagram for OutputStream:

[legend]

Public Types
typedef std::vector< DataStoreItem * >	Items

typedef std::vector< std::string >	ItemNames

typedef std::map< Gaudi::Algorithm *, Items >	AlgDependentItems

typedef std::map< std::string, ItemNames >	AlgDependentItemNames

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 Member Functions
StatusCode	start () override
	Start OutputStream.

StatusCode	initialize () override
	Initialize OutputStream.

StatusCode	finalize () override
	Terminate OutputStream.

StatusCode	execute () override
	Working entry point.

virtual StatusCode	connectConversionSvc ()

virtual bool	collect (IRegistry *dir, int level)
	Store agent's classback.

virtual StatusCode	collectObjects ()
	Collect all objects to be written to the output stream.

void	clearSelection ()
	Clear list of selected objects.

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

Public Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
	LegacyAlgorithmAdapter (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)

const EventContext &	getContext () const

bool	isExecuted () const
	Has this algorithm been executed since the last reset?

void	setExecuted (bool state) const
	Set the executed flag to the specified state.

bool	filterPassed () const
	Did this algorithm pass or fail its filter criterion for the last event?

void	setFilterPassed (bool state) const
	Set the filter passed flag to the specified state.

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)

Protected Member Functions
Gaudi::Algorithm *	decodeAlgorithm (const std::string &theName)
	Decode a single algorithm name.

void	decodeAlgorithms (Gaudi::Property< std::vector< std::string > > &theNames, std::vector< Gaudi::Algorithm * > &theAlgs)
	Decode specified list of Algorithms.

bool	isEventAccepted () const
	Test whether this event should be output.

DataStoreItem *	findItem (const std::string &path)
	Find single item identified by its path (exact match)

virtual StatusCode	writeObjects ()
	Select the different objects and write them to file.

virtual bool	hasInput () const
	Tell if the instance has been configured with input items or not.

Protected Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
bool	isReEntrant () const override

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
Gaudi::Property< ItemNames >	m_itemNames { this, "ItemList", {}, "vector of item names to be saved to this stream" }

Gaudi::Property< ItemNames >	m_optItemNames

Gaudi::Property< AlgDependentItemNames >	m_algDependentItemList

Gaudi::Property< bool >	m_doPreLoad

Gaudi::Property< bool >	m_doPreLoadOpt

Gaudi::Property< std::string >	m_output { this, "Output", {}, "name of the output file specification" }

Gaudi::Property< std::string >	m_outputName { this, "OutputFile", {}, "name of the output file" }

Gaudi::Property< std::string >	m_storeName

Gaudi::Property< std::string >	m_persName

Gaudi::Property< std::vector< std::string > >	m_acceptNames

Gaudi::Property< std::vector< std::string > >	m_requireNames

Gaudi::Property< std::vector< std::string > >	m_vetoNames

Gaudi::Property< bool >	m_verifyItems

bool	m_fireIncidents = true
	should I fire incidents for writing opening/closing etc?

SmartIF< IIncidentSvc >	m_incidentSvc
	Reference to the incident service.

std::string	m_outputType = "UPDATE"
	Output type: NEW(NEW,CREATE,WRITE,RECREATE), UPDATE)

SmartIF< IDataProviderSvc >	m_pDataProvider
	Keep reference to the data provider service.

SmartIF< IDataManagerSvc >	m_pDataManager
	Keep reference to the data manager service.

SmartIF< IConversionSvc >	m_pConversionSvc
	Keep reference to the data conversion service.

DataStoreItem *	m_currentItem
	Keep track of the current item.

Items	m_itemList
	Vector of items to be saved to this stream.

Items	m_optItemList
	Vector of optional items to be saved to this stream.

AlgDependentItems	m_algDependentItems
	Items to be saved for specific algorithms.

IDataSelector	m_objects
	Collection of objects being selected.

int	m_events
	Number of events written to this output stream.

std::vector< Gaudi::Algorithm * >	m_acceptAlgs
	Vector of Algorithms that this stream accepts.

std::vector< Gaudi::Algorithm * >	m_requireAlgs
	Vector of Algorithms that this stream requires.

std::vector< Gaudi::Algorithm * >	m_vetoAlgs
	Vector of Algorithms that this stream is vetoed by.

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

Private Member Functions
void	clearItems (Items &itms)
	Clear item list.

void	addItem (Items &itms, const std::string &descriptor)
	Add item to output streamer list.

IDataSelector *	selectedObjects ()
	Return the list of selected objects.

StatusCode	collectFromSubTree (DataObject *)

Additional Inherited Members
Public Attributes inherited from Gaudi::Algorithm
friend	AlgorithmManager

Detailed Description

A small to stream Data I/O.

Author: M.Frank author R. Lambert Version: 1.0

Definition at line 37 of file OutputStream.h.

Member Typedef Documentation

◆ AlgDependentItemNames

typedef std::map<std::string, ItemNames> OutputStream::AlgDependentItemNames

Definition at line 42 of file OutputStream.h.

◆ AlgDependentItems

typedef std::map<Gaudi::Algorithm*, Items> OutputStream::AlgDependentItems

Definition at line 41 of file OutputStream.h.

◆ ItemNames

typedef std::vector<std::string> OutputStream::ItemNames

Definition at line 40 of file OutputStream.h.

◆ Items

typedef std::vector<DataStoreItem*> OutputStream::Items

Definition at line 39 of file OutputStream.h.

Member Function Documentation

◆ addItem()

void OutputStream::addItem	(	Items &	itms,
		const std::string &	descriptor )

private

Add item to output streamer list.

Definition at line 343 of file OutputStream.cpp.

                                                                     {
  int         level    = 0;
  auto        sep      = descriptor.rfind( "#" );
  std::string obj_path = descriptor.substr( 0, sep );
  if ( sep != std::string::npos ) {
    std::string slevel = descriptor.substr( sep + 1 );
    level              = ( slevel == "*" ) ? 9999999 : std::stoi( slevel );
  }
  if ( m_verifyItems ) {
    size_t idx = obj_path.find( "/", 1 );
    while ( idx != std::string::npos ) {
      std::string sub_item = obj_path.substr( 0, idx );
      if ( !findItem( sub_item ) ) addItem( itms, sub_item + "#1" );
      idx = obj_path.find( "/", idx + 1 );
    }
  }
  itms.push_back( new DataStoreItem( obj_path, level ) );
  const auto& item = itms.back();
  ON_DEBUG
  debug() << "Adding OutputStream item " << item->path() << " with " << item->depth() << " level(s)." << endmsg;
}

◆ clearItems()

void OutputStream::clearItems ( Items & itms )

private

Clear item list.

Definition at line 326 of file OutputStream.cpp.

                                           {
  for ( auto& i : itms ) delete i;
  itms.clear();
}

◆ clearSelection()

void OutputStream::clearSelection ( )

Clear list of selected objects.

Definition at line 323 of file OutputStream.cpp.

323{ m_objects.clear(); }

OutputStream::m_objects

IDataSelector m_objects

Collection of objects being selected.

Definition OutputStream.h:114

◆ collect()

bool OutputStream::collect	(	IRegistry *	dir,
		int	level )

virtual

Store agent's classback.

Definition at line 234 of file OutputStream.cpp.

                                                      {
  if ( level < m_currentItem->depth() ) {
    if ( dir->object() ) {
      /*
        std::cout << "Analysing ("
        << dir->name()
        << ") Object:"
        << ((dir->object()==0) ? "UNLOADED" : "LOADED")
        << std::endl;
      */
      m_objects.push_back( dir->object() );
      return true;
    }
  }
  return false;
}

◆ collectFromSubTree()

StatusCode OutputStream::collectFromSubTree ( DataObject * pObj )

private

Definition at line 518 of file OutputStream.cpp.

                                                              {
  return m_pDataManager->traverseSubTree( pObj,
                                          [this]( IRegistry* r, int level ) { return this->collect( r, level ); } );
}

◆ collectObjects()

StatusCode OutputStream::collectObjects ( )

virtual

Collect all objects to be written to the output stream.

Reimplemented in CopyInputStream, and InputCopyStream.

Definition at line 252 of file OutputStream.cpp.

                                        {
  StatusCode status = StatusCode::SUCCESS;
 
  // Traverse the tree and collect the requested objects
  for ( auto& i : m_itemList ) {
    DataObject* obj = nullptr;
    m_currentItem   = i;
    StatusCode iret = m_pDataProvider->retrieveObject( m_currentItem->path(), obj );
    if ( iret.isSuccess() ) {
      iret = collectFromSubTree( obj );
      if ( !iret.isSuccess() ) status = iret;
    } else {
      error() << "Cannot write mandatory object(s) (Not found) " << m_currentItem->path() << endmsg;
      status = iret;
    }
  }
 
  // Traverse the tree and collect the requested objects (tolerate missing items here)
  for ( auto& i : m_optItemList ) {
    DataObject* obj = nullptr;
    m_currentItem   = i;
    StatusCode iret = m_pDataProvider->retrieveObject( m_currentItem->path(), obj );
    if ( iret.isSuccess() ) iret = collectFromSubTree( obj );
    if ( !iret.isSuccess() ) {
      ON_DEBUG
      debug() << "Ignore request to write non-mandatory object(s) " << m_currentItem->path() << endmsg;
    }
  }
 
  // Collect objects dependent on particular algorithms
  for ( const auto& iAlgItems : m_algDependentItems ) {
    auto         alg   = iAlgItems.first;
    const Items& items = iAlgItems.second;
    if ( passed( alg ) ) {
      ON_DEBUG
      debug() << "Algorithm '" << alg->name() << "' fired. Adding " << items << endmsg;
      for ( const auto& i : items ) {
        DataObject* obj = nullptr;
        m_currentItem   = i;
        StatusCode iret = m_pDataProvider->retrieveObject( m_currentItem->path(), obj );
        if ( iret.isSuccess() ) {
          iret = collectFromSubTree( obj );
          if ( !iret.isSuccess() ) status = iret;
        } else {
          error() << "Cannot write mandatory (algorithm dependent) object(s) (Not found) " << m_currentItem->path()
                  << endmsg;
          status = iret;
        }
      }
    }
  }
 
  if ( status.isSuccess() ) {
    // Remove duplicates from the list of objects, preserving the order in the list
    std::set<DataObject*>    unique;
    std::vector<DataObject*> tmp; // temporary vector with the reduced list
    tmp.reserve( m_objects.size() );
    for ( auto& o : m_objects ) {
      if ( !unique.count( o ) ) {
        // if the pointer is not in the set, add it to both the set and the temporary vector
        unique.insert( o );
        tmp.push_back( o );
      }
    }
    m_objects.swap( tmp ); // swap the data of the two vectors
  }
 
  return status;
}

◆ connectConversionSvc()

StatusCode OutputStream::connectConversionSvc ( )

virtual

Definition at line 366 of file OutputStream.cpp.

                                              {
  StatusCode status = StatusCode::FAILURE;
  // Get output file from input
  std::string dbType, svc, shr;
  for ( auto attrib : Gaudi::Utils::AttribStringParser( m_output ) ) {
    const std::string& tag = attrib.tag;
    const std::string& val = attrib.value;
    switch ( ::toupper( tag[0] ) ) {
    case 'D':
      m_outputName = val;
      break;
    case 'T':
      dbType = val;
      break;
    case 'S':
      switch ( ::toupper( tag[1] ) ) {
      case 'V':
        svc = val;
        break;
      case 'H':
        shr = "YES";
        break;
      }
      break;
    case 'O': // OPT='<NEW<CREATE,WRITE,RECREATE>, UPDATE>'
      switch ( ::toupper( val[0] ) ) {
      case 'R':
        if ( ::strncasecmp( val.c_str(), "RECREATE", 3 ) == 0 )
          m_outputType = "RECREATE";
        else if ( ::strncasecmp( val.c_str(), "READ", 3 ) == 0 )
          m_outputType = "READ";
        break;
      case 'C':
      case 'N':
      case 'W':
        m_outputType = "NEW";
        break;
      case 'U':
        m_outputType = "UPDATE";
        break;
      default:
        m_outputType = "???";
        break;
      }
      break;
    default:
      break;
    }
  }
  if ( !shr.empty() ) m_outputType += "|SHARED";
  // Get access to the default Persistency service
  // The default service is the same for input as for output.
  // If this is not desired, then a specialized OutputStream must overwrite
  // this value.
  if ( !dbType.empty() || !svc.empty() ) {
    std::string typ   = !dbType.empty() ? dbType : svc;
    auto        ipers = serviceLocator()->service<IPersistencySvc>( m_persName );
    if ( !ipers ) {
      fatal() << "Unable to locate IPersistencySvc interface of " << m_persName << endmsg;
      return StatusCode::FAILURE;
    }
    IConversionSvc* cnvSvc = nullptr;
    status                 = ipers->getService( typ, cnvSvc );
    if ( !status.isSuccess() ) {
      fatal() << "Unable to locate IConversionSvc interface of database type " << typ << endmsg;
      return status;
    }
    // Increase reference count and keep service.
    m_pConversionSvc = cnvSvc;
  } else {
    fatal() << "Unable to locate IConversionSvc interface (Unknown technology) " << endmsg
            << "You either have to specify a technology name or a service name!" << endmsg
            << "Please correct the job option \"" << name() << ".Output\" !" << endmsg;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

◆ decodeAlgorithm()

Gaudi::Algorithm * OutputStream::decodeAlgorithm ( const std::string & theName )

protected

Decode a single algorithm name.

Definition at line 444 of file OutputStream.cpp.

                                                                        {
  Gaudi::Algorithm* theAlgorithm = nullptr;
 
  auto theAlgMgr = serviceLocator()->as<IAlgManager>();
  if ( theAlgMgr ) {
    // Check whether the supplied name corresponds to an existing
    // Algorithm object.
    SmartIF<IAlgorithm>& theIAlg = theAlgMgr->algorithm( theName );
    if ( theIAlg ) {
      try {
        theAlgorithm = dynamic_cast<Gaudi::Algorithm*>( theIAlg.get() );
      } catch ( ... ) {
        // do nothing
      }
    }
  } else {
    fatal() << "Can't locate ApplicationMgr!!!" << endmsg;
  }
 
  if ( !theAlgorithm ) { warning() << "Failed to decode Algorithm name " << theName << endmsg; }
 
  return theAlgorithm;
}

◆ decodeAlgorithms()

void OutputStream::decodeAlgorithms	(	Gaudi::Property< std::vector< std::string > > &	theNames,
		std::vector< Gaudi::Algorithm * > &	theAlgs )

protected

Decode specified list of Algorithms.

Definition at line 468 of file OutputStream.cpp.

                                                                                      {
  // Reset the list of Algorithms
  theAlgs.clear();
 
  // Build the list of Algorithms from the names list
  for ( const auto& it : theNames.value() ) {
 
    auto theAlgorithm = decodeAlgorithm( it );
    if ( theAlgorithm ) {
      // Check that the specified algorithm doesn't already exist in the list
      if ( std::find( std::begin( theAlgs ), std::end( theAlgs ), theAlgorithm ) == std::end( theAlgs ) ) {
        theAlgorithm->addRef();
        theAlgs.push_back( theAlgorithm );
      }
    } else {
      info() << it << " doesn't exist - ignored" << endmsg;
    }
  }
}

◆ execute()

StatusCode OutputStream::execute ( )

overridevirtual

Working entry point.

Implements Algorithm.

Reimplemented in RecordStream, RunRecordStream, and SequentialOutputStream.

Definition at line 162 of file OutputStream.cpp.

                                 {
  // Clear any previously existing item list
  clearSelection();
  // Test whether this event should be output
  if ( isEventAccepted() ) {
    const StatusCode sc = writeObjects();
    clearSelection();
    ++m_events;
    if ( sc.isSuccess() && m_fireIncidents ) {
      m_incidentSvc->fireIncident( Incident( m_outputName, IncidentType::WroteToOutputFile ) );
    } else if ( m_fireIncidents ) {
      m_incidentSvc->fireIncident( Incident( m_outputName, IncidentType::FailOutputFile ) );
    }
    return sc;
  }
  return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode OutputStream::finalize ( )

override

Terminate OutputStream.

Definition at line 149 of file OutputStream.cpp.

                                  {
  info() << "Events output: " << m_events << endmsg;
  if ( m_fireIncidents ) m_incidentSvc->fireIncident( Incident( m_outputName, IncidentType::EndOutputFile ) );
  m_incidentSvc.reset();
  m_pDataProvider.reset();
  m_pDataManager.reset();
  m_pConversionSvc.reset();
  clearItems( m_optItemList );
  clearItems( m_itemList );
  return StatusCode::SUCCESS;
}

◆ findItem()

DataStoreItem * OutputStream::findItem ( const std::string & path )

protected

Find single item identified by its path (exact match)

Definition at line 332 of file OutputStream.cpp.

                                                             {
  auto matchPath = [&]( const DataStoreItem* i ) { return i->path() == path; };
  auto i         = std::find_if( m_itemList.begin(), m_itemList.end(), matchPath );
  if ( i == m_itemList.end() ) {
    i = std::find_if( m_optItemList.begin(), m_optItemList.end(), matchPath );
    if ( i == m_optItemList.end() ) return nullptr;
  }
  return *i;
}

◆ hasInput()

bool OutputStream::hasInput ( ) const

protectedvirtual

Tell if the instance has been configured with input items or not.

Reimplemented in CopyInputStream, and InputCopyStream.

Definition at line 514 of file OutputStream.cpp.

                                  {
  return !( m_itemNames.empty() && m_optItemNames.empty() && m_algDependentItemList.empty() );
}

◆ initialize()

StatusCode OutputStream::initialize ( )

override

Initialize OutputStream.

Definition at line 54 of file OutputStream.cpp.

                                    {
  auto status = Algorithm::initialize();
  if ( status.isFailure() ) return status;
 
  if ( m_output.empty() ) {
    fatal() << "property Output not set. OutputStream instances require an output" << endmsg;
    return StatusCode::FAILURE;
  }
 
  // Reset the number of events written
  m_events = 0;
  // Get access to the DataManagerSvc
  m_pDataManager = serviceLocator()->service( m_storeName );
  if ( !m_pDataManager ) {
    fatal() << "Unable to locate IDataManagerSvc interface" << endmsg;
    return StatusCode::FAILURE;
  }
  // Get access to the IncidentService
  m_incidentSvc = serviceLocator()->service( "IncidentSvc" );
  if ( !m_incidentSvc ) {
    warning() << "Error retrieving IncidentSvc." << endmsg;
    return StatusCode::FAILURE;
  }
  // Get access to the assigned data service
  m_pDataProvider = serviceLocator()->service( m_storeName );
  if ( !m_pDataProvider ) {
    fatal() << "Unable to locate IDataProviderSvc interface of " << m_storeName << endmsg;
    return StatusCode::FAILURE;
  }
  if ( hasInput() ) {
    StatusCode status = connectConversionSvc();
    if ( !status.isSuccess() ) {
      fatal() << "Unable to connect to conversion service." << endmsg;
      if ( m_outputName != "" && m_fireIncidents )
        m_incidentSvc->fireIncident( Incident( m_outputName, IncidentType::FailOutputFile ) );
      return status;
    }
  }
 
  // Clear the list with optional items
  clearItems( m_optItemList );
  // Clear the item list
  clearItems( m_itemList );
 
  // Take the new item list from the properties.
  ON_DEBUG debug() << "ItemList    : " << m_itemNames.value() << endmsg;
  for ( const auto& i : m_itemNames ) addItem( m_itemList, i );
 
  // Take the new item list from the properties.
  ON_DEBUG debug() << "OptItemList : " << m_optItemNames.value() << endmsg;
  for ( const auto& i : m_optItemNames ) addItem( m_optItemList, i );
 
  // prepare the algorithm selected dependent locations
  ON_DEBUG debug() << "AlgDependentItemList : " << m_algDependentItemList.value() << endmsg;
  for ( const auto& a : m_algDependentItemList ) {
    // Get the algorithm pointer
    auto theAlgorithm = decodeAlgorithm( a.first );
    if ( theAlgorithm ) {
      // Get the item list for this alg
      auto& items = m_algDependentItems[theAlgorithm];
      // Clear the list for this alg
      clearItems( items );
      // fill the list again
      for ( const auto& i : a.second ) addItem( items, i );
    }
  }
 
  // Take the item list to the data service preload list.
  if ( m_doPreLoad ) {
    for ( auto& j : m_itemList ) m_pDataProvider->addPreLoadItem( *j ).ignore();
    // Not working: bad reference counting! pdataSvc->release();
  }
 
  if ( m_doPreLoadOpt ) {
    for ( auto& j : m_optItemList ) m_pDataProvider->addPreLoadItem( *j ).ignore();
  }
  info() << "Data source: " << m_storeName.value() << " output: " << m_output.value() << endmsg;
 
  // Decode the accept, required and veto Algorithms. The logic is the following:
  //  a. The event is accepted if all lists are empty.
  //  b. The event is provisionally accepted if any Algorithm in the accept list
  //     has been executed and has indicated that its filter is passed. This
  //     provisional acceptance can be overridden by the other lists.
  //  c. The event is rejected unless all Algorithms in the required list have
  //     been executed and have indicated that their filter passed.
  //  d. The event is rejected if any Algorithm in the veto list has been
  //     executed and has indicated that its filter has passed.
  m_acceptNames.useUpdateHandler();
  m_requireNames.useUpdateHandler();
  m_vetoNames.useUpdateHandler();
 
  return StatusCode::SUCCESS;
}

◆ isEventAccepted()

bool OutputStream::isEventAccepted ( ) const

protected

Test whether this event should be output.

Definition at line 489 of file OutputStream.cpp.

                                         {
  // Loop over all Algorithms in the accept list to see
  // whether any have been executed and have their filter
  // passed flag set. Any match causes the event to be
  // provisionally accepted.
  bool result = m_acceptAlgs.empty() || std::any_of( std::begin( m_acceptAlgs ), std::end( m_acceptAlgs ), passed );
 
  // Loop over all Algorithms in the required list to see
  // whether all have been executed and have their filter
  // passed flag set. Any mismatch causes the event to be
  // rejected.
  if ( result && !m_requireAlgs.empty() ) {
    result = std::all_of( std::begin( m_requireAlgs ), std::end( m_requireAlgs ), passed );
  }
 
  // Loop over all Algorithms in the veto list to see
  // whether any have been executed and have their filter
  // passed flag set. Any match causes the event to be
  // rejected.
  if ( result && !m_vetoAlgs.empty() ) {
    result = std::none_of( std::begin( m_vetoAlgs ), std::end( m_vetoAlgs ), passed );
  }
  return result;
}

◆ selectedObjects()

IDataSelector * OutputStream::selectedObjects ( )

inlineprivate

Return the list of selected objects.

Definition at line 164 of file OutputStream.h.

164{ return &m_objects; }

◆ start()

StatusCode OutputStream::start ( )

override

Start OutputStream.

Definition at line 46 of file OutputStream.cpp.

                               {
  return Algorithm::start().andThen( [this]() {
    // Open the output file now to ensure it is always written even if empty
    return m_pConversionSvc->connectOutput( m_outputName, m_outputType );
  } );
}

◆ writeObjects()

StatusCode OutputStream::writeObjects ( )

protectedvirtual

Select the different objects and write them to file.

Reimplemented in SequentialOutputStream, and TagCollectionStream.

Definition at line 181 of file OutputStream.cpp.

                                      {
  // Connect the output file to the service
  StatusCode status = collectObjects();
  if ( status.isSuccess() ) {
    IDataSelector* sel = selectedObjects();
    if ( sel->begin() != sel->end() ) {
      status = m_pConversionSvc->connectOutput( m_outputName, m_outputType );
      if ( status.isSuccess() ) {
        // Now pass the collection to the persistency service
        IOpaqueAddress* pAddress = nullptr;
        for ( auto& j : *sel ) {
          try {
            const StatusCode iret = m_pConversionSvc->createRep( j, pAddress );
            if ( !iret.isSuccess() ) {
              status = iret;
              continue;
            }
            IRegistry* pReg = j->registry();
            pReg->setAddress( pAddress );
          } catch ( const std::exception& excpt ) {
            const std::string loc = ( j->registry() ? j->registry()->identifier() : "UnRegistered" );
            fatal() << "std::exception during createRep for '" << loc << "' " << System::typeinfoName( typeid( *j ) )
                    << endmsg;
            fatal() << excpt.what() << endmsg;
            throw;
          }
        }
        for ( auto& j : *sel ) {
          try {
            IRegistry*       pReg = j->registry();
            const StatusCode iret = m_pConversionSvc->fillRepRefs( pReg->address(), j );
            if ( !iret.isSuccess() ) status = iret;
          } catch ( const std::exception& excpt ) {
            const std::string loc = ( j->registry() ? j->registry()->identifier() : "UnRegistered" );
            fatal() << "std::exception during fillRepRefs for '" << loc << "'" << System::typeinfoName( typeid( *j ) )
                    << endmsg;
            fatal() << excpt.what() << endmsg;
            throw;
          }
        }
        // Commit the data if there was no error; otherwise possibly discard
        if ( status.isSuccess() ) {
          status = m_pConversionSvc->commitOutput( m_outputName, true );
        } else {
          m_pConversionSvc->commitOutput( m_outputName, false ).ignore();
        }
      }
    }
  }
  return status;
}

Member Data Documentation

◆ m_acceptAlgs

std::vector<Gaudi::Algorithm*> OutputStream::m_acceptAlgs

protected

Vector of Algorithms that this stream accepts.

Definition at line 119 of file OutputStream.h.

◆ m_acceptNames

Gaudi::Property<std::vector<std::string> > OutputStream::m_acceptNames

protected

Initial value:

{
      this,
      "AcceptAlgs",
      {},
      [this]( auto& ) { this->decodeAlgorithms( this->m_acceptNames, this->m_acceptAlgs ); },
      "names of Algorithms that this stream accepts" }

Definition at line 68 of file OutputStream.h.

                                                   {
      this,
      "AcceptAlgs",
      {},
      [this]( auto& ) { this->decodeAlgorithms( this->m_acceptNames, this->m_acceptAlgs ); },
      "names of Algorithms that this stream accepts" };

◆ m_algDependentItemList

Gaudi::Property<AlgDependentItemNames> OutputStream::m_algDependentItemList

protected

Initial value:

{
      this,
      "AlgDependentItemList",
      {},
      "mapping between algorithm names, and a list of items for which, if the "
      "algorithm in question accepted the event, they should be also stored" }

Definition at line 52 of file OutputStream.h.

                                                             {
      this,
      "AlgDependentItemList",
      {},
      "mapping between algorithm names, and a list of items for which, if the "
      "algorithm in question accepted the event, they should be also stored" };

◆ m_algDependentItems

AlgDependentItems OutputStream::m_algDependentItems

protected

Items to be saved for specific algorithms.

Definition at line 112 of file OutputStream.h.

◆ m_currentItem

DataStoreItem* OutputStream::m_currentItem

protected

Keep track of the current item.

Definition at line 106 of file OutputStream.h.

◆ m_doPreLoad

Gaudi::Property<bool> OutputStream::m_doPreLoad

protected

Initial value:

{ this, "Preload", true,

"flag indicating whether data pre-loading should be performed" }

Definition at line 58 of file OutputStream.h.

58 { this, "Preload", true,

59 "flag indicating whether data pre-loading should be performed" };

◆ m_doPreLoadOpt

Gaudi::Property<bool> OutputStream::m_doPreLoadOpt

protected

Initial value:

{ this, "PreloadOptItems", false,

"flag indicating whether optional items should be preloaded" }

Definition at line 60 of file OutputStream.h.

60 { this, "PreloadOptItems", false,

61 "flag indicating whether optional items should be preloaded" };

◆ m_events

int OutputStream::m_events

protected

Number of events written to this output stream.

Definition at line 116 of file OutputStream.h.

◆ m_fireIncidents

bool OutputStream::m_fireIncidents = true

protected

should I fire incidents for writing opening/closing etc?

in the baseclass, always fire the incidents by default in e.g. RecordStream this will be set to false, and configurable

Definition at line 92 of file OutputStream.h.

◆ m_incidentSvc

SmartIF<IIncidentSvc> OutputStream::m_incidentSvc

protected

Reference to the incident service.

Definition at line 95 of file OutputStream.h.

◆ m_itemList

Items OutputStream::m_itemList

protected

Vector of items to be saved to this stream.

Definition at line 108 of file OutputStream.h.

◆ m_itemNames

Gaudi::Property<ItemNames> OutputStream::m_itemNames { this, "ItemList", {}, "vector of item names to be saved to this stream" }

protected

Definition at line 49 of file OutputStream.h.

49{ this, "ItemList", {}, "vector of item names to be saved to this stream" };

◆ m_objects

IDataSelector OutputStream::m_objects

protected

Collection of objects being selected.

Definition at line 114 of file OutputStream.h.

◆ m_optItemList

Items OutputStream::m_optItemList

protected

Vector of optional items to be saved to this stream.

Definition at line 110 of file OutputStream.h.

◆ m_optItemNames

Gaudi::Property<ItemNames> OutputStream::m_optItemNames

protected

Initial value:

{

this, "OptItemList", {}, "vector of optional item names to be saved to this stream" }

Definition at line 50 of file OutputStream.h.

50 {

51 this, "OptItemList", {}, "vector of optional item names to be saved to this stream" };

◆ m_output

Gaudi::Property<std::string> OutputStream::m_output { this, "Output", {}, "name of the output file specification" }

protected

Definition at line 62 of file OutputStream.h.

62{ this, "Output", {}, "name of the output file specification" };

◆ m_outputName

Gaudi::Property<std::string> OutputStream::m_outputName { this, "OutputFile", {}, "name of the output file" }

protected

Definition at line 63 of file OutputStream.h.

63{ this, "OutputFile", {}, "name of the output file" };

◆ m_outputType

std::string OutputStream::m_outputType = "UPDATE"

protected

Output type: NEW(NEW,CREATE,WRITE,RECREATE), UPDATE)

Definition at line 98 of file OutputStream.h.

◆ m_pConversionSvc

SmartIF<IConversionSvc> OutputStream::m_pConversionSvc

protected

Keep reference to the data conversion service.

Definition at line 104 of file OutputStream.h.

◆ m_pDataManager

SmartIF<IDataManagerSvc> OutputStream::m_pDataManager

protected

Keep reference to the data manager service.

Definition at line 102 of file OutputStream.h.

◆ m_pDataProvider

SmartIF<IDataProviderSvc> OutputStream::m_pDataProvider

protected

Keep reference to the data provider service.

Definition at line 100 of file OutputStream.h.

◆ m_persName

Gaudi::Property<std::string> OutputStream::m_persName

protected

Initial value:

{ this, "EvtConversionSvc", "EventPersistencySvc",

"name of the persistency service capable to write data from the store" }

Definition at line 66 of file OutputStream.h.

66 { this, "EvtConversionSvc", "EventPersistencySvc",

67 "name of the persistency service capable to write data from the store" };

◆ m_requireAlgs

std::vector<Gaudi::Algorithm*> OutputStream::m_requireAlgs

protected

Vector of Algorithms that this stream requires.

Definition at line 121 of file OutputStream.h.

◆ m_requireNames

Gaudi::Property<std::vector<std::string> > OutputStream::m_requireNames

protected

Initial value:

{
      this,
      "RequireAlgs",
      {},
      [this]( auto& ) { this->decodeAlgorithms( this->m_requireNames, this->m_requireAlgs ); },
      "names of Algorithms that this stream requires" }

Definition at line 74 of file OutputStream.h.

                                                    {
      this,
      "RequireAlgs",
      {},
      [this]( auto& ) { this->decodeAlgorithms( this->m_requireNames, this->m_requireAlgs ); },
      "names of Algorithms that this stream requires" };

◆ m_storeName

Gaudi::Property<std::string> OutputStream::m_storeName

protected

Initial value:

{ this, "EvtDataSvc", "EventDataSvc",

"name of the service managing the data store" }

Definition at line 64 of file OutputStream.h.

64 { this, "EvtDataSvc", "EventDataSvc",

65 "name of the service managing the data store" };

◆ m_verifyItems

Gaudi::Property<bool> OutputStream::m_verifyItems

protected

Initial value:

{ this, "VerifyItems", true,

"flag to indicate that item consistency should be checked" }

Definition at line 86 of file OutputStream.h.

86 { this, "VerifyItems", true,

87 "flag to indicate that item consistency should be checked" };

◆ m_vetoAlgs

std::vector<Gaudi::Algorithm*> OutputStream::m_vetoAlgs

protected

Vector of Algorithms that this stream is vetoed by.

Definition at line 123 of file OutputStream.h.

◆ m_vetoNames

Gaudi::Property<std::vector<std::string> > OutputStream::m_vetoNames

protected

Initial value:

{
      this,
      "VetoAlgs",
      {},
      [this]( auto& ) { this->decodeAlgorithms( this->m_vetoNames, this->m_vetoAlgs ); },
      "names of Algorithms that this stream is vetoed by" }

Definition at line 80 of file OutputStream.h.

                                                 {
      this,
      "VetoAlgs",
      {},
      [this]( auto& ) { this->decodeAlgorithms( this->m_vetoNames, this->m_vetoAlgs ); },
      "names of Algorithms that this stream is vetoed by" };

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

GaudiCommonSvc/src/PersistencySvc/OutputStream.h
GaudiCommonSvc/src/PersistencySvc/OutputStream.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AlgDependentItemNames

◆ AlgDependentItems

◆ ItemNames

◆ Items

Member Function Documentation

◆ addItem()

◆ clearItems()

◆ clearSelection()

◆ collect()

◆ collectFromSubTree()

◆ collectObjects()

◆ connectConversionSvc()

◆ decodeAlgorithm()

◆ decodeAlgorithms()

◆ execute()

◆ finalize()

◆ findItem()

◆ hasInput()

◆ initialize()

◆ isEventAccepted()

◆ selectedObjects()

◆ start()

◆ writeObjects()

Member Data Documentation

◆ m_acceptAlgs

◆ m_acceptNames

◆ m_algDependentItemList

◆ m_algDependentItems

◆ m_currentItem

◆ m_doPreLoad

◆ m_doPreLoadOpt

◆ m_events

◆ m_fireIncidents

◆ m_incidentSvc

◆ m_itemList

◆ m_itemNames

◆ m_objects

◆ m_optItemList

◆ m_optItemNames

◆ m_output

◆ m_outputName

◆ m_outputType

◆ m_pConversionSvc

◆ m_pDataManager

◆ m_pDataProvider

◆ m_persName

◆ m_requireAlgs

◆ m_requireNames

◆ m_storeName

◆ m_verifyItems

◆ m_vetoAlgs

◆ m_vetoNames