EvtDataSvc Class Reference

A EvtDataSvc is the base class for event services. More...

#include </builds/gaudi/Gaudi/GaudiCommonSvc/src/DataSvc/EvtDataSvc.h>

Inheritance diagram for EvtDataSvc:

Collaboration diagram for EvtDataSvc:

Public Member Functions
StatusCode	initialize () override
	Service initialisation.
StatusCode	reinitialize () override
	Service reinitialisation.
StatusCode	finalize () override
	Service finalization.
	DataSvc (const DataSvc &)=delete
	copy constructor disabled
Public Member Functions inherited from DataSvc
CLID	rootCLID () const override
	IDataManagerSvc: Accessor for root event CLID.
const std::string &	rootName () const override
	IDataManagerSvc: Accessor for root event name.
StatusCode	registerAddress (std::string_view fullPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store.
StatusCode	registerAddress (IRegistry *parentObj, std::string_view objectPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store.
StatusCode	unregisterAddress (std::string_view fullPath) override
	IDataManagerSvc: Unregister object address from the data store.
StatusCode	unregisterAddress (IRegistry *pParent, std::string_view objPath) override
	IDataManagerSvc: Unregister object address from the data store.
StatusCode	objectLeaves (const DataObject *pObject, std::vector< IRegistry * > &refLeaves) override
	IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object.
StatusCode	objectLeaves (const IRegistry *pRegistry, std::vector< IRegistry * > &refLeaves) override
	IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object.
StatusCode	objectParent (const DataObject *pObject, IRegistry *&refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent.
StatusCode	objectParent (const IRegistry *pRegistry, IRegistry *&refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent.
StatusCode	clearSubTree (std::string_view sub_tree_path) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by its full path name.
StatusCode	clearSubTree (DataObject *pObject) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by the object.
StatusCode	clearStore () override
	IDataManagerSvc: Remove all data objects in the data store.
StatusCode	traverseSubTree (std::string_view sub_tree_path, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree identified by its full path name.
StatusCode	traverseSubTree (DataObject *pObject, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree.
StatusCode	traverseTree (IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects in the data store.
StatusCode	setRoot (std::string root_name, DataObject *pRootObj) override
	Initialize data store for new event by giving new event path and root object.
virtual StatusCode	i_setRoot (std::string root_name, DataObject *pRootObj)
	Initialize data store for new event by giving new event path and root object.
StatusCode	setRoot (std::string root_path, IOpaqueAddress *pRootAddr) override
	Initialize data store for new event by giving new event path and address of root object.
virtual StatusCode	i_setRoot (std::string root_path, IOpaqueAddress *pRootAddr)
	Initialize data store for new event by giving new event path and address of root object.
StatusCode	setDataLoader (IConversionSvc *svc, IDataProviderSvc *dpsvc=nullptr) override
	IDataManagerSvc: IDataManagerSvc: Pass a default data loader to the service and optionally a data provider.
StatusCode	addPreLoadItem (const DataStoreItem &item) override
	Add an item to the preload list.
StatusCode	removePreLoadItem (const DataStoreItem &item) override
	Remove an item from the preload list.
StatusCode	resetPreLoad () override
	Clear the preload list.
virtual StatusCode	preLoad (int depth, int load_depth, DataObject *pObject)
	Execute one level of preloading and recursively load until the final level is reached.
StatusCode	preLoad () override
	load all preload items of the list
StatusCode	registerObject (std::string_view parentPath, std::string_view objPath, DataObject *pObject) override
	Register object with the data store.
StatusCode	registerObject (DataObject *parentObj, std::string_view objPath, DataObject *pObject) override
	Register object with the data store.
StatusCode	unregisterObject (std::string_view fullPath) override
	Unregister object from the data store.
StatusCode	unregisterObject (DataObject *pObject) override
	Unregister object from the data store.
StatusCode	unregisterObject (DataObject *pObject, std::string_view objectPath) override
	Unregister object from the data store.
StatusCode	retrieveObject (IRegistry *pDirectory, std::string_view path, DataObject *&pObject) override
	Retrieve object from data store.
StatusCode	findObject (std::string_view fullPath, DataObject *&pObject) override
	Find object identified by its full path in the data store.
StatusCode	findObject (IRegistry *pDirectory, std::string_view path, DataObject *&pObject) override
	Find object identified by its full path in the data store.
StatusCode	linkObject (IRegistry *from, std::string_view objPath, DataObject *to) override
	Add a link to another object.
StatusCode	linkObject (std::string_view fullPath, DataObject *to) override
	Add a link to another object.
StatusCode	unlinkObject (IRegistry *from, std::string_view objPath) override
	Remove a link to another object.
StatusCode	unlinkObject (DataObject *fromObj, std::string_view objPath) override
	Remove a link to another object.
StatusCode	unlinkObject (std::string_view fullPath) override
	Remove a link to another object.
StatusCode	updateObject (IRegistry *pDirectory) override
	Update object identified by its directory entry.
StatusCode	updateObject (DataObject *toUpdate) override
	Update object.
StatusCode	initialize () override
	Service initialization.
StatusCode	reinitialize () override
	Service initialization.
StatusCode	finalize () override
	Service initialization.
	DataSvc (const DataSvc &)=delete
	copy constructor disabled
DataSvc &	operator= (const DataSvc &)=delete
	Fake assignment operator (never implemented).
StatusCode	registerAddress (DataObject *parentObj, std::string_view objectPath, IOpaqueAddress *pAddress)
	Register object address with the data store.
StatusCode	unregisterAddress (DataObject *pParent, std::string_view objPath)
	Unregister object address from the data store.
StatusCode	registerObject (std::string_view fullPath, DataObject *pObject)
	Register object with the data store.
StatusCode	registerObject (std::string_view parentPath, int item, DataObject *pObject)
	Register object with the data store.
StatusCode	registerObject (DataObject *parentObj, int item, DataObject *pObject)
	Register object with the data store.
StatusCode	retrieveObject (std::string_view fullPath, DataObject *&pObject)
	Retrieve object identified by its full path from the data store.
StatusCode	retrieveObject (std::string_view parentPath, std::string_view objectPath, DataObject *&pObject)
	Retrieve object from data store.
StatusCode	retrieveObject (std::string_view parentPath, int item, DataObject *&pObject)
	Retrieve object from data store.
StatusCode	retrieveObject (DataObject *parentObj, std::string_view objectPath, DataObject *&pObject)
	Retrieve object from data store.
StatusCode	retrieveObject (DataObject *parentObj, int item, DataObject *&pObject)
	Retrieve object from data store.
StatusCode	findObject (std::string_view parentPath, std::string_view objectPath, DataObject *&pObject)
	Find object identified by its parent object and the path to the object relative to the parent.
StatusCode	findObject (std::string_view parentPath, int item, DataObject *&pObject)
	Find object identified by its parent object and an integer identifier in the data store.
StatusCode	findObject (DataObject *parentObj, std::string_view objectPath, DataObject *&pObject)
	Find object identified by its parent object and the path to the object relative to the parent.
StatusCode	findObject (DataObject *parentObj, int item, DataObject *&pObject)
	Find object identified by its parent object and an integer identifier in the data store.
StatusCode	linkObject (std::string_view fromPath, std::string_view objPath, DataObject *toObj)
	Add a link to another object.
StatusCode	linkObject (DataObject *fromObj, std::string_view objPath, DataObject *toObj)
	Add a link to another object.
StatusCode	unlinkObject (std::string_view fromPath, std::string_view objPath)
	Remove a link to another object.
Public Member Functions inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
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 Service
const std::string &	name () const override
	Retrieve name of the service.
StatusCode	configure () override
StatusCode	initialize () override
StatusCode	start () override
StatusCode	stop () override
StatusCode	finalize () override
StatusCode	terminate () override
Gaudi::StateMachine::State	FSMState () const override
Gaudi::StateMachine::State	targetFSMState () const override
StatusCode	reinitialize () override
StatusCode	restart () override
StatusCode	sysInitialize () override
	Initialize Service.
StatusCode	sysStart () override
	Initialize Service.
StatusCode	sysStop () override
	Initialize Service.
StatusCode	sysFinalize () override
	Finalize Service.
StatusCode	sysReinitialize () override
	Re-initialize the Service.
StatusCode	sysRestart () override
	Re-initialize the Service.
	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.
template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const
template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
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)
	Declare used tool.
template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")
template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)
const std::vector< IAlgTool * > &	tools () const
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, 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< IService, 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)

Private Attributes
SmartIF< IConversionSvc >	m_cnvSvc

Additional Inherited Members
Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
using	base_class
	Typedef to this class.
using	extend_interfaces_base
	Typedef to the base of this class.
Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService*( const std::string&, ISvcLocator* )>
Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...
Protected Member Functions inherited from DataSvc
bool	checkRoot ()
	Check if root path is valid.
virtual IConversionSvc *	getDataLoader (IRegistry *pReg)
	Retrieve customizable data loader according to registry entry to be retrieved.
virtual DataObject *	createDefaultObject () const
	Create default objects in case forced creation of leaves is requested.
virtual StatusCode	loadObject (IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation.
virtual StatusCode	loadObject (IConversionSvc *pLoader, IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation.
StatusCode	retrieveEntry (DataSvcHelpers::RegistryEntry *pNode, std::string_view path, DataSvcHelpers::RegistryEntry *&pEntry)
	Retrieve registry entry from store.
DataObject *	handleDataFault (IRegistry *pReg, std::string_view path="")
	Invoke data fault handling if enabled.
Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()
	~Service () override
int	outputLevel () const
	get the Service's output level
Protected Member Functions inherited from CommonMessaging< implements< IService, 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 DataSvc
SmartIF< IIncidentSvc >	m_incidentSvc = nullptr
	Pointer to incident service.
Gaudi::Property< CLID >	m_rootCLID { this, "RootCLID", 110 , "CLID of root entry" }
Gaudi::Property< std::string >	m_rootName { this, "RootName", "/Event", "name of root entry" }
std::unique_ptr< DataSvcHelpers::RegistryEntry >	m_root
	Pointer to root entry.
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.
Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools
Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }
Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }
Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }
Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }
Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }
Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }
Gaudi::Property< bool >	m_autoRetrieveTools
Gaudi::Property< bool >	m_checkToolDeps
SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

A EvtDataSvc is the base class for event services.

Author

M.Frank

Definition at line 22 of file EvtDataSvc.h.

Member Function Documentation

DataSvc()

DataSvc::DataSvc ( const DataSvc & )

delete

copy constructor disabled

finalize()

StatusCode EvtDataSvc::finalize ( )

override

Service finalization.

Definition at line 55 of file EvtDataSvc.cpp.

                                {
  m_cnvSvc = nullptr; // release
  DataSvc::finalize().ignore();
  return StatusCode::SUCCESS;
}

initialize()

StatusCode EvtDataSvc::initialize ( )

override

Service initialisation.

Definition at line 40 of file EvtDataSvc.cpp.

                                  {
  // Nothing to do: just call base class initialisation
  StatusCode status = DataSvc::initialize();
 
  // Attach data loader facility
  m_cnvSvc = serviceLocator()->service( "EventPersistencySvc" );
  status   = setDataLoader( m_cnvSvc );
  return status;
}

reinitialize()

StatusCode EvtDataSvc::reinitialize ( )

override

Service reinitialisation.

Definition at line 50 of file EvtDataSvc.cpp.

                                    {
  // Do nothing for this service
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_cnvSvc

SmartIF<IConversionSvc> EvtDataSvc::m_cnvSvc

private

Definition at line 30 of file EvtDataSvc.h.

---

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

• GaudiCommonSvc/src/DataSvc/EvtDataSvc.h
• GaudiCommonSvc/src/DataSvc/EvtDataSvc.cpp