RecordStream Class Reference

Extension of OutputStream to write run records after last event. More...

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

Inheritance diagram for RecordStream:

Collaboration diagram for RecordStream:

Public Member Functions
	RecordStream (const std::string &, ISvcLocator *)
	Standard algorithm Constructor.
StatusCode	execute () override
	Runrecords do not get written for each event: Event processing hence dummy....
StatusCode	finalize () override
	Algorithm overload: finalization.
Public Member Functions inherited from OutputStream
StatusCode	start () override
	Start OutputStream.
StatusCode	initialize () override
	Initialize OutputStream.
StatusCode	finalize () override
	Terminate OutputStream.
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)

Additional Inherited Members
Public Types inherited from OutputStream
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 Attributes inherited from Gaudi::Algorithm
friend	AlgorithmManager
Protected Member Functions inherited from OutputStream
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 inherited from OutputStream
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

Detailed Description

Extension of OutputStream to write run records after last event.

Author

M.Frank

Version

1.0

Definition at line 22 of file RecordStream.h.

Constructor & Destructor Documentation

RecordStream()

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

Standard algorithm Constructor.

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

Definition at line 25 of file RecordStream.cpp.

                                                                            : OutputStream( name, pSvcLocator ) {
  declareProperty( "FireIncidents", m_fireIncidents = false, "if to fire incidents for writing opening/closing etc" );
}

Member Function Documentation

execute()

StatusCode RecordStream::execute ( )

inlineoverridevirtual

Runrecords do not get written for each event: Event processing hence dummy....

Reimplemented from OutputStream.

Definition at line 27 of file RecordStream.h.

{ return StatusCode::SUCCESS; }

finalize()

StatusCode RecordStream::finalize ( )

override

Algorithm overload: finalization.

Definition at line 31 of file RecordStream.cpp.

                                  {
  info() << "Set up File Summary Record" << endmsg;
  if ( !m_fireIncidents && msgLevel( MSG::VERBOSE ) ) verbose() << "will not fire incidents" << endmsg;
  StatusCode sc = OutputStream::execute();
  if ( !sc.isSuccess() ) { warning() << "Error writing run summary record....." << endmsg; }
  return OutputStream::finalize();
}

---

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

• GaudiCommonSvc/src/PersistencySvc/RecordStream.h
• GaudiCommonSvc/src/PersistencySvc/RecordStream.cpp