Specialized output stream class for event tag collections, where the basic Event entry point should be placed as well into the collection itself. More...

#include <PersistencySvc/TagCollectionStream.h>

Inheritance diagram for TagCollectionStream:

[legend]

Collaboration diagram for TagCollectionStream:

[legend]

Public Member Functions
	TagCollectionStream (const std::string &name, ISvcLocator *pSvcLocator)
	Standard algorithm Constructor. More...

	~TagCollectionStream () override=default
	Standard Destructor. More...

StatusCode	initialize () override
	Initialize TagCollectionStream. More...

StatusCode	finalize () override
	Terminate TagCollectionStream. More...

Public Member Functions inherited from OutputStream
	OutputStream (const std::string &name, ISvcLocator *pSvcLocator)
	Standard algorithm Constructor. More...

virtual	~OutputStream ()=default
	Standard Destructor. More...

StatusCode	initialize () override
	Initialize OutputStream. More...

StatusCode	finalize () override
	Terminate OutputStream. More...

StatusCode	execute () override
	Working entry point. More...

virtual StatusCode	connectConversionSvc ()

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

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

void	clearSelection ()
	Clear list of selected objects. More...

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

	~Algorithm () override=default
	Destructor. More...

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

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

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

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

StatusCode	sysExecute () override
	The actions to be performed by the algorithm on an event. More...

StatusCode	sysStop () override
	System stop. More...

StatusCode	sysFinalize () override
	System finalization. More...

StatusCode	sysBeginRun () override
	beginRun method invoked by the framework. More...

StatusCode	sysEndRun () override
	endRun method invoked by the framework. More...

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

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

void	setType (const std::string &type) override

const std::string &	version () const override

unsigned int	index () override

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

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

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

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

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

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

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

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

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

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

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

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

void	resetExecuted () override
	Reset the executed state of the Algorithm for the duration of the current event. More...

StatusCode	beginRun () override
	Algorithm begin run. More...

StatusCode	endRun () override
	Algorithm end run. This method is called at the end of the event loop. More...

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

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

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

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

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

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

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

void	setOutputLevel (int level)
	Set the output level for current algorithm. More...

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

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

SmartIF< IChronoStatSvc > &	chronoStatService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IDataProviderSvc > &	detDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IConversionSvc > &	detDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

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

SmartIF< IDataProviderSvc > &	eventDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IConversionSvc > &	eventDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IHistogramSvc > &	histogramDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IMessageSvc > &	messageService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< INTupleSvc > &	ntupleService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IRndmGenSvc > &	randSvc () const
	AIDA-based NTuple service Returns a pointer to the AIDATuple service if present. More...

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

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

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

SmartIF< ITimelineSvc > &	timelineSvc () const

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

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

SmartIF< IHiveWhiteBoard > &	whiteboard () const

bool	registerContext () const
	register for Algorithm Context Service? More...

StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
	Create a sub algorithm. More...

const std::vector< Algorithm * > *	subAlgorithms () const
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

std::vector< Algorithm * > *	subAlgorithms ()
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

StatusCode	setProperty (const Property &p) override
	Implementation of IProperty::setProperty. More...

StatusCode	setProperty (const std::string &s) override
	Implementation of IProperty::setProperty. More...

StatusCode	setProperty (const std::string &n, const std::string &v) override
	Implementation of IProperty::setProperty. More...

StatusCode	getProperty (Property *p) const override
	Implementation of IProperty::getProperty. More...

const Property &	getProperty (const std::string &name) const override
	Implementation of IProperty::getProperty. More...

StatusCode	getProperty (const std::string &n, std::string &v) const override
	Implementation of IProperty::getProperty. More...

const std::vector< Property * > &	getProperties () const override
	Implementation of IProperty::getProperties. More...

bool	hasProperty (const std::string &name) const override
	Implementation of IProperty::hasProperty. More...

StatusCode	setProperties ()
	Set the algorithm's properties. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

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

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

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

EventContext *	getContext ()
	get the context More...

void	setContext (EventContext *context)
	set the context More...

template<typename T >
	__attribute__ ((deprecated)) StatusCode declareDataObj(const std
	Declare data object. More...

template<class T >
StatusCode	declareInput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::string &address=DataObjectDescriptor::NULL_, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::READ)
	Declare input data object. More...

template<class T >
StatusCode	declareInput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::vector< std::string > &addresses, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::READ)
	Declare input data object. More...

template<class T >
StatusCode	declareOutput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::string &address=DataObjectDescriptor::NULL_, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::WRITE)
	Declare output data object. More...

__attribute__((deprecated)) const std const DataObjectDescriptorCollection &	inputDataObjects () const override
	Return the handles declared in the algorithm. More...

const DataObjectDescriptorCollection &	outputDataObjects () const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...

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

bool	isClonable () const override
	Specifies the clonability of the algorithm. More...

unsigned int	cardinality () const override
	Return the cardinality. More...

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

	Algorithm (const std::string &name, ISvcLocator *svcloc, const std::string &version=PACKAGE_VERSION)
	Constructor. More...

	~Algorithm () override=default
	Destructor. More...

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

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

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

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

StatusCode	sysExecute () override
	The actions to be performed by the algorithm on an event. More...

StatusCode	sysStop () override
	System stop. More...

StatusCode	sysFinalize () override
	System finalization. More...

StatusCode	sysBeginRun () override
	beginRun method invoked by the framework. More...

StatusCode	sysEndRun () override
	endRun method invoked by the framework. More...

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

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

void	setType (const std::string &type) override

const std::string &	version () const override

unsigned int	index () override

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

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

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

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

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

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

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

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

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

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

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

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

void	resetExecuted () override
	Reset the executed state of the Algorithm for the duration of the current event. More...

StatusCode	beginRun () override
	Algorithm begin run. More...

StatusCode	endRun () override
	Algorithm end run. This method is called at the end of the event loop. More...

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

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

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

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

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

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

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

void	setOutputLevel (int level)
	Set the output level for current algorithm. More...

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

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

SmartIF< IChronoStatSvc > &	chronoStatService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IDataProviderSvc > &	detDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IConversionSvc > &	detDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

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

SmartIF< IDataProviderSvc > &	eventDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IConversionSvc > &	eventDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IHistogramSvc > &	histogramDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< IMessageSvc > &	messageService () const
	Obsoleted name, kept due to the backwards compatibility. More...

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

SmartIF< INTupleSvc > &	ntupleService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IRndmGenSvc > &	randSvc () const
	AIDA-based NTuple service Returns a pointer to the AIDATuple service if present. More...

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

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

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

SmartIF< ITimelineSvc > &	timelineSvc () const

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

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

SmartIF< IHiveWhiteBoard > &	whiteboard () const

bool	registerContext () const
	register for Algorithm Context Service? More...

StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
	Create a sub algorithm. More...

const std::vector< Algorithm * > *	subAlgorithms () const
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

std::vector< Algorithm * > *	subAlgorithms ()
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

StatusCode	setProperty (const Property &p) override
	Implementation of IProperty::setProperty. More...

StatusCode	setProperty (const std::string &s) override
	Implementation of IProperty::setProperty. More...

StatusCode	setProperty (const std::string &n, const std::string &v) override
	Implementation of IProperty::setProperty. More...

StatusCode	getProperty (Property *p) const override
	Implementation of IProperty::getProperty. More...

const Property &	getProperty (const std::string &name) const override
	Implementation of IProperty::getProperty. More...

StatusCode	getProperty (const std::string &n, std::string &v) const override
	Implementation of IProperty::getProperty. More...

const std::vector< Property * > &	getProperties () const override
	Implementation of IProperty::getProperties. More...

bool	hasProperty (const std::string &name) const override
	Implementation of IProperty::hasProperty. More...

StatusCode	setProperties ()
	Set the algorithm's properties. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

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

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

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

EventContext *	getContext ()
	get the context More...

void	setContext (EventContext *context)
	set the context More...

template<typename T >
	__attribute__ ((deprecated)) StatusCode declareDataObj(const std
	Declare data object. More...

template<class T >
StatusCode	declareInput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::string &address=DataObjectDescriptor::NULL_, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::READ)
	Declare input data object. More...

template<class T >
StatusCode	declareInput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::vector< std::string > &addresses, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::READ)
	Declare input data object. More...

template<class T >
StatusCode	declareOutput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::string &address=DataObjectDescriptor::NULL_, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::WRITE)
	Declare output data object. More...

__attribute__((deprecated)) const std const DataObjectDescriptorCollection &	inputDataObjects () const override
	Return the handles declared in the algorithm. More...

const DataObjectDescriptorCollection &	outputDataObjects () const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...

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

bool	isClonable () const override
	Specifies the clonability of the algorithm. More...

unsigned int	cardinality () const override
	Return the cardinality. More...

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

Public Member Functions inherited from implements< Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

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

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

	implements ()=default
	Default constructor. More...

	implements (const implements &)
	Copy constructor (zero the reference count) More...

implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...

	~implements () override=default
	Virtual destructor. More...

unsigned long	addRef () override
	Reference Interface instance. More...

unsigned long	release () override
	Release Interface instance. More...

unsigned long	refCount () const override
	Current reference count. More...

void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

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

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

	implements ()=default
	Default constructor. More...

	implements (const implements &)
	Copy constructor (zero the reference count) More...

implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...

	~implements () override=default
	Virtual destructor. More...

unsigned long	addRef () override
	Reference Interface instance. More...

unsigned long	release () override
	Release Interface instance. More...

unsigned long	refCount () const override
	Current reference count. More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Member Functions
StatusCode	writeObjects () override
	OutputStream override: Select the different objects and write them to file. More...

virtual StatusCode	connectAddress ()
	Connect address column, if not already connected. More...

StatusCode	writeData ()
	Write data objects. More...

StatusCode	writeTuple ()
	Write tuple data. More...

StatusCode	writeRecord ()
	Write full event record. More...

Protected Member Functions inherited from OutputStream
StatusCode	decodeAcceptAlgs ()
	Decode list of Algorithms that this stream accepts. More...

void	acceptAlgsHandler (Property &theProp)
	Handler for AcceptAlgs Property. More...

StatusCode	decodeRequireAlgs ()
	Decode list of Algorithms that this stream requires. More...

void	requireAlgsHandler (Property &theProp)
	Handler for RequireAlgs Property. More...

StatusCode	decodeVetoAlgs ()
	Decode list of Algorithms that this stream is vetoed by. More...

void	vetoAlgsHandler (Property &theProp)
	Handler for VetoAlgs Property. More...

Algorithm *	decodeAlgorithm (const std::string &theName)
	Decode a single algorithm name. More...

StatusCode	decodeAlgorithms (StringArrayProperty &theNames, std::vector< Algorithm * > &theAlgs)
	Decode specified list of Algorithms. More...

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

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

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

Protected Member Functions inherited from Algorithm
DataObjectDescriptorCollection &	inputDataObjects ()

DataObjectDescriptorCollection &	outputDataObjects ()

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

void	addSubAlgorithmDataObjectHandles ()

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

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

int	outputLevel () const
	retrieve the Algorithm output level More...

IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property. More...

void	initOutputLevel (Property &prop)
	Callback for output level property. More...

DataObjectDescriptorCollection &	inputDataObjects ()

DataObjectDescriptorCollection &	outputDataObjects ()

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

void	addSubAlgorithmDataObjectHandles ()

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

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

int	outputLevel () const
	retrieve the Algorithm output level More...

IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property. More...

void	initOutputLevel (Property &prop)
	Callback for output level property. More...

Protected Attributes
std::string	m_addrLeaf = "/Event"
	Property: Name of the address leaf in the transient event store. More...

std::string	m_addrColName = "Address"
	Property: Name of the address column of the tag collection. More...

std::string	m_tagName
	Property: Name of the tag collection in the transient store. More...

std::string	m_collSvcName = "NTupleSvc"
	Property: Name of the collection service. More...

bool	m_objectsFirst = true
	Property: Flag to indicate that the objects should be written first. More...

INTupleItem *	m_addrColumn = nullptr
	NTuple column to hold the opaque address of the address leaf. More...

std::string	m_topLeafName
	Name of the top leaf (performance cache) More...

bool	m_isTopLeaf = false
	Short cut flag to indicate if the address leaf is the top leaf (performace cache) More...

SmartIF< INTupleSvc >	m_collectionSvc
	Keep reference to the tuple service. More...

std::unique_ptr< GenericAddress >	m_addr
	Address buffer. More...

NTuple::Item< IOpaqueAddress * >	m_item
	Address item buffer. More...

Protected Attributes inherited from OutputStream
SmartIF< IIncidentSvc >	m_incidentSvc
	Reference to the incident service. More...

bool	m_doPreLoad
	Flag indicating whether data pre-loading should be performed. More...

bool	m_doPreLoadOpt
	Flag indicating whether optional items should be preloaded. More...

bool	m_verifyItems
	Flag to indicate that item consistency should be checked. More...

std::string	m_storeName
	Name of the service managing the data store. More...

std::string	m_persName
	Name of the persistency service capable to write data from the store. More...

std::string	m_output
	Name of the output file specification. More...

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

std::string	m_outputType
	Output type: NEW(NEW,CREATE,WRITE,RECREATE), UPDATE) More...

std::unique_ptr< OutputStreamAgent >	m_agent
	Keep reference of agent. More...

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

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

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

DataStoreItem *	m_currentItem
	Keep track of the current item. More...

ItemNames	m_itemNames
	Vector of item names. More...

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

ItemNames	m_optItemNames
	Vector of item names. More...

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

AlgDependentItemNames	m_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. More...

AlgDependentItems	m_algDependentItems
	Items to be saved for specific algorithms. More...

IDataSelector	m_objects
	Collection of objects being selected. More...

int	m_events
	Number of events written to this output stream. More...

StringArrayProperty	m_acceptNames
	Vector of names of Algorithms that this stream accepts. More...

StringArrayProperty	m_requireNames
	Vector of names of Algorithms that this stream requires. More...

StringArrayProperty	m_vetoNames
	Vector of names of Algorithms that this stream is vetoed by. More...

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

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

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

bool	m_fireIncidents
	should I fire incidents for writing opening/closing etc? More...

Protected Attributes inherited from Algorithm
EventContext *	m_event_context
	Event specific data for multiple event processing. More...

Protected Attributes inherited from implements< Interfaces >
std::atomic_ulong	m_refCount = {0}
	Reference counter. More...

Additional Inherited Members
Public Types inherited from OutputStream
typedef std::vector< DataStoreItem * >	Items

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

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

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

Public Types inherited from Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm , const std::string &, ISvcLocator >	Factory

typedef Gaudi::PluginService::Factory< IAlgorithm , const std::string &, ISvcLocator >	Factory

Public Types inherited from implements< Interfaces >
using	base_class = implements< Interfaces...>
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

using	iids = typename extend_interfaces_base::ext_iids

using	base_class = implements< Interfaces...>
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

using	iids = typename extend_interfaces_base::ext_iids

Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Specialized output stream class for event tag collections, where the basic Event entry point should be placed as well into the collection itself.

The TagCollectionStream is a rather specialized object combining features of NTuple I/O and object I/O. The main working points are:

1) Write a "normal" tag collection. The address column [property AddressColumn, default:"Address"] is added to the Ntuple identified by its name [mandatory property Collection]. The address column is set to the opaque address of the specified leaf [property "AddressLeaf", default:"/Event"]. The NTuple must be registered to the TES of the service [property: TagCollectionSvc, default:"NTupleSvc"]. This is the normal mode event tag collections work.

2) Write a tag collection with "REDIRECTED INPUT". Example: The collection is created from an intermediate file (MINI DST), but the Address column of the NTuple should point to the file e.g. containing the raw data.

Set the property "AddressLeaf" to something different from "/Event" e.g. "/Event/DAQ/RawEvent"

Note: The actual address of "/Event" get changed. No other output should be created after writing such a tag collection.

3) Write an "EMBEDDED COLLECTION". In this mode the OutputStream and the NTuple stream are combined. depending on the property TagCollectionStream.ObjectsFirst the objects are written first and the the tags. The tag file and the file containing the objects may be identical.

Note:

Also if the OutputStream features are NOT used, the options must still be properly set.
Tags or objects are only written to the output stream if the event is accepted according to the output stream criteria (veto algorithms, etc.)
If the address column is not present in the N-tuple (ie. it was not added by the N-tuple creator), it is automatically added at the first write attempt.
If the logical N-tuple output file is not yet connected to the tuple service, it is automatically connected to the the same as the OutputStream device.

Author: M.Frank Version: 1.0

Definition at line 62 of file TagCollectionStream.h.

Constructor & Destructor Documentation

TagCollectionStream::TagCollectionStream	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Standard algorithm Constructor.

Definition at line 18 of file TagCollectionStream.cpp.

   : OutputStream(nam, pSvc), m_addr{  new GenericAddress() }
 {
   declareProperty("AddressLeaf",      m_addrLeaf     = "/Event" );
   declareProperty("AddressColumn",    m_addrColName  = "Address");
   declareProperty("TagCollectionSvc", m_collSvcName  = "NTupleSvc");
   declareProperty("ObjectsFirst",     m_objectsFirst = true);
   declareProperty("Collection",       m_tagName );
 }

TagCollectionStream::~TagCollectionStream ( )

overridedefault

Standard Destructor.

Member Function Documentation

StatusCode TagCollectionStream::connectAddress ( )

protectedvirtual

Connect address column, if not already connected.

Definition at line 30 of file TagCollectionStream.cpp.

                                                 {
   NTuplePtr nt(m_collectionSvc, m_tagName);
   if ( !nt )    {
     MsgStream log(msgSvc(), name());
     log << MSG::ERROR << "Failed to connect to the tag collection "
         << m_tagName << endmsg;
     return StatusCode::FAILURE;
   }
   m_addrColumn = nt->find(m_addrColName);
   if ( m_addrColumn )  return StatusCode::SUCCESS;
   StatusCode sc = nt->addItem (m_addrColName,m_item);
   if ( sc.isSuccess() )  {
     m_addrColumn = m_item.operator->();
     return sc;
   }
   MsgStream log(msgSvc(), name());
   log << MSG::ERROR << "Failed to add the address column:"
       << m_addrColName << " to the tag collection " << m_tagName
       << endmsg;
   return sc;
 }

StatusCode TagCollectionStream::finalize ( )

override

Terminate TagCollectionStream.

Definition at line 101 of file TagCollectionStream.cpp.

                                          {
   MsgStream log(msgSvc(), name());
   StatusCode status = OutputStream::finalize();
   m_collectionSvc.reset();
   m_addrColumn = nullptr;
   return status;
 }

StatusCode TagCollectionStream::initialize ( )

override

Initialize TagCollectionStream.

Definition at line 53 of file TagCollectionStream.cpp.

                                            {
   using Parser = Gaudi::Utils::AttribStringParser;
   std::string log_node, log_file, logical_name;
   m_collectionSvc = service(m_collSvcName, true);
   if ( m_collectionSvc )  {
     std::string tmp;
     for(auto attrib: Parser(m_output)) {
       switch( ::toupper(attrib.tag[0]) )    {
       case 'C':
         m_tagName = std::move(attrib.value);
         break;
       case 'A':
         m_addrLeaf = std::move(attrib.value);
         break;
       default:
         tmp += attrib.tag + "='" + attrib.value + "' ";
         break;
       }
     }
     m_output = std::move(tmp);
     std::string::size_type idx = m_tagName[0]==SEPARATOR ? m_tagName.find(SEPARATOR,1) : 0;
     log_node = m_tagName.substr(idx,m_tagName.find(SEPARATOR,idx+1));
     log_file = log_node + " " + m_output + " SHARED='YES'";
   }
   m_addrColumn = nullptr;                           // reset pointer to item column
   auto sc = OutputStream::initialize();            // Now initialize the base class
   if ( sc.isSuccess() )  {
     auto src_mgr = m_collectionSvc.as<IDataSourceMgr>();
     if ( src_mgr )  {
       auto data_mgr = m_collectionSvc.as<IDataManagerSvc>();
       if ( data_mgr )  {
         logical_name = data_mgr->rootName();
         logical_name += SEPARATOR;
         logical_name += log_node;
         m_topLeafName = m_addrLeaf.substr(0,m_addrLeaf.find(SEPARATOR,m_addrLeaf[0]=='/' ? 1 : 0));
         m_isTopLeaf   = m_topLeafName == m_addrLeaf;
         if ( src_mgr->isConnected(logical_name) )  return sc;
         sc = src_mgr->connect(log_file);
         if ( sc.isSuccess() )  return sc;
       }
     }
   }
   MsgStream log(msgSvc(), name());
   log << MSG::ERROR << "Failed to initialize TagCollection Stream." << endmsg;
   return StatusCode::FAILURE;
 }

StatusCode TagCollectionStream::writeData ( )

protected

Write data objects.

Definition at line 121 of file TagCollectionStream.cpp.

                                           {
   StatusCode sc = OutputStream::writeObjects();
   if ( !sc.isSuccess() )  {
     MsgStream log(msgSvc(), name());
     log << MSG::ERROR << "Failed to write tag collection " << m_tagName << ". "
         << "[Object write error]" << endmsg;
   }
   return sc;
 }

StatusCode TagCollectionStream::writeObjects ( )

overrideprotectedvirtual

OutputStream override: Select the different objects and write them to file.

Reimplemented from OutputStream.

Definition at line 140 of file TagCollectionStream.cpp.

                                              {
   StatusCode status =  !m_addrColumn ? connectAddress() : StatusCode::SUCCESS;
   if ( status.isSuccess() )  {
     status = m_objectsFirst ? writeData() : StatusCode::SUCCESS;
     if ( status.isSuccess() && !m_addrColName.empty() )  {
       SmartDataPtr<DataObject> top(eventSvc(), m_topLeafName);
       if ( !top )  {
         MsgStream log0(msgSvc(), name());
         log0 << MSG::ERROR << "Failed to write tag collection " << m_tagName << ". "
             << m_topLeafName << " not found." << endmsg;
         return StatusCode::FAILURE;
       }
       IOpaqueAddress* pA = top->registry()->address();
       if ( !pA )  {
         MsgStream log1(msgSvc(), name());
         log1 << MSG::ERROR << "Failed to write tag collection " << m_tagName << ". "
             << m_topLeafName << "'s address not found." << endmsg;
         return StatusCode::FAILURE;
       }
       std::string*    par = (std::string*)m_addr->par();
       unsigned long* ipar = (unsigned long*)m_addr->ipar();
       m_addr->setClID(pA->clID());
       m_addr->setSvcType(pA->svcType());
       par[0]  = pA->par()[0];
       par[1]  = pA->par()[1];
       ipar[0] = pA->ipar()[0];
       ipar[1] = pA->ipar()[1];
       *(IOpaqueAddress**)(m_addrColumn->buffer()) = m_addr.get();
       if ( m_isTopLeaf )  return writeRecord();
       // Handle redirection mode. Normal tag collection mode
       // is the same like leaving this out....
       SmartDataPtr<DataObject> leaf(eventSvc(), m_addrLeaf);
       if ( !leaf )  {
         MsgStream log2(msgSvc(), name());
         log2 << MSG::ERROR << "Failed to write tag collection " << m_tagName << ". "
             << m_addrLeaf << " not found." << endmsg;
         return StatusCode::FAILURE;
       }
       IOpaqueAddress* redir = leaf->registry()->address();
       if ( !redir )  {
         MsgStream log3(msgSvc(), name());
         log3 << MSG::ERROR << "Failed to write tag collection " << m_tagName << ". "
             << m_addrLeaf << "'s address not found." << endmsg;
         return StatusCode::FAILURE;
       }
       par[0]  = redir->par()[0];
       ipar[0] = ~0x0;
       ipar[1] = redir->ipar()[1];
       return writeRecord();
     }
   }
   return status;
 }

StatusCode TagCollectionStream::writeRecord ( )

protected

Write full event record.

Definition at line 132 of file TagCollectionStream.cpp.

                                             {
   if ( writeTuple().isSuccess() )  {
     return m_objectsFirst ? StatusCode::SUCCESS : writeData();
   }
   return StatusCode::FAILURE;
 }

StatusCode TagCollectionStream::writeTuple ( )

protected

Write tuple data.

Definition at line 110 of file TagCollectionStream.cpp.

                                            {
   StatusCode sc = m_collectionSvc->writeRecord(m_tagName);
   if ( !sc.isSuccess() )  {
     MsgStream log(msgSvc(), name());
     log << MSG::ERROR << "Failed to write tag collection " << m_tagName << ". "
         << "[Tuple write error]" << endmsg;
   }
   return sc;
 }

Member Data Documentation

std::unique_ptr<GenericAddress> TagCollectionStream::m_addr

protected

Address buffer.

Definition at line 84 of file TagCollectionStream.h.

std::string TagCollectionStream::m_addrColName = "Address"

protected

Property: Name of the address column of the tag collection.

Definition at line 68 of file TagCollectionStream.h.

INTupleItem* TagCollectionStream::m_addrColumn = nullptr

protected

NTuple column to hold the opaque address of the address leaf.

Definition at line 76 of file TagCollectionStream.h.

std::string TagCollectionStream::m_addrLeaf = "/Event"

protected

Property: Name of the address leaf in the transient event store.

Definition at line 66 of file TagCollectionStream.h.

SmartIF<INTupleSvc> TagCollectionStream::m_collectionSvc

protected

Keep reference to the tuple service.

Definition at line 82 of file TagCollectionStream.h.

std::string TagCollectionStream::m_collSvcName = "NTupleSvc"

protected

Property: Name of the collection service.

Definition at line 72 of file TagCollectionStream.h.

bool TagCollectionStream::m_isTopLeaf = false

protected

Short cut flag to indicate if the address leaf is the top leaf (performace cache)

Definition at line 80 of file TagCollectionStream.h.

NTuple::Item<IOpaqueAddress*> TagCollectionStream::m_item

protected

Address item buffer.

Definition at line 86 of file TagCollectionStream.h.

bool TagCollectionStream::m_objectsFirst = true

protected

Property: Flag to indicate that the objects should be written first.

Definition at line 74 of file TagCollectionStream.h.

std::string TagCollectionStream::m_tagName

protected

Property: Name of the tag collection in the transient store.

Definition at line 70 of file TagCollectionStream.h.

std::string TagCollectionStream::m_topLeafName

protected

Name of the top leaf (performance cache)

Definition at line 78 of file TagCollectionStream.h.

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

GaudiCommonSvc/src/PersistencySvc/TagCollectionStream.h
GaudiCommonSvc/src/PersistencySvc/TagCollectionStream.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation