DataSvc Class Reference

Data service base class. More...

#include <GaudiKernel/DataSvc.h>

Inheritance diagram for DataSvc:

Collaboration diagram for DataSvc:

Public Types
typedef std::vector< DataStoreItem >	LoadItems
	Define set of load items. More...
Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
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 = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging
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...

Public Member Functions
CLID	rootCLID () const override
	IDataManagerSvc: Accessor for root event CLID. More...
const std::string &	rootName () const override
	IDataManagerSvc: Accessor for root event name. More...
StatusCode	registerAddress (boost::string_ref fullPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	registerAddress (DataObject *parentObj, boost::string_ref objectPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	registerAddress (IRegistry *parentObj, boost::string_ref objectPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	unregisterAddress (boost::string_ref fullPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	unregisterAddress (DataObject *pParent, boost::string_ref objPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	unregisterAddress (IRegistry *pParent, boost::string_ref objPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	objectLeaves (const DataObject *pObject, std::vector< IRegistry * > &refLeaves) override
	IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object. More...
StatusCode	objectLeaves (const IRegistry *pRegistry, std::vector< IRegistry * > &refLeaves) override
	IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object. More...
StatusCode	objectParent (const DataObject *pObject, IRegistry *&refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent. More...
StatusCode	objectParent (const IRegistry *pRegistry, IRegistry *&refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent. More...
StatusCode	clearSubTree (boost::string_ref sub_tree_path) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by its full path name. More...
StatusCode	clearSubTree (DataObject *pObject) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by the object. More...
StatusCode	clearStore () override
	IDataManagerSvc: Remove all data objects in the data store. More...
StatusCode	traverseSubTree (boost::string_ref sub_tree_path, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree identified by its full path name. More...
StatusCode	traverseSubTree (DataObject *pObject, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree. More...
StatusCode	traverseTree (IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects in the data store. More...
StatusCode	setRoot (std::string root_name, DataObject *pRootObj) override
	Initialize data store for new event by giving new event path and root object. More...
virtual StatusCode	i_setRoot (std::string root_name, DataObject *pRootObj)
	Initialize data store for new event by giving new event path and root object. More...
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. More...
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. More...
StatusCode	setDataLoader (IConversionSvc *svc, IDataProviderSvc *dpsvc=nullptr) override
	IDataManagerSvc: IDataManagerSvc: Pass a default data loader to the service and optionally a data provider. More...
StatusCode	addPreLoadItem (const DataStoreItem &item) override
	Add an item to the preload list. More...
StatusCode	addPreLoadItem (std::string itemPath) override
	Add an item to the preload list. More...
StatusCode	removePreLoadItem (const DataStoreItem &item) override
	Remove an item from the preload list. More...
StatusCode	removePreLoadItem (std::string itemPath) override
	Add an item to the preload list. More...
StatusCode	resetPreLoad () override
	Clear the preload list. More...
virtual StatusCode	preLoad (int depth, int load_depth, DataObject *pObject)
	Execute one level of preloading and recursively load until the final level is reached. More...
StatusCode	preLoad () override
	load all preload items of the list More...
StatusCode	registerObject (boost::string_ref fullPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (boost::string_ref parentPath, boost::string_ref objPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (boost::string_ref parentPath, int item, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (DataObject *parentObj, boost::string_ref objPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (DataObject *parentObj, int item, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	unregisterObject (boost::string_ref fullPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (boost::string_ref parentPath, boost::string_ref objectPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (boost::string_ref parentPath, int item) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject, boost::string_ref objectPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject, int item) override
	Unregister object from the data store. More...
StatusCode	retrieveObject (IRegistry *pDirectory, boost::string_ref path, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (boost::string_ref fullPath, DataObject *&pObject) override
	Retrieve object identified by its full path from the data store. More...
StatusCode	retrieveObject (boost::string_ref parentPath, boost::string_ref objPath, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (boost::string_ref parentPath, int item, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (DataObject *parentObj, boost::string_ref objPath, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (DataObject *parentObj, int item, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	findObject (boost::string_ref fullPath, DataObject *&pObject) override
	Find object identified by its full path in the data store. More...
StatusCode	findObject (IRegistry *pDirectory, boost::string_ref path, DataObject *&pObject) override
	Find object identified by its full path in the data store. More...
StatusCode	findObject (boost::string_ref parentPath, boost::string_ref objPath, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (boost::string_ref parentPath, int item, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (DataObject *parentObj, boost::string_ref objPath, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (DataObject *parentObj, int item, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	linkObject (IRegistry *from, boost::string_ref objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (boost::string_ref fromPath, boost::string_ref objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (DataObject *from, boost::string_ref objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (boost::string_ref fullPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	unlinkObject (IRegistry *from, boost::string_ref objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (boost::string_ref fromPath, boost::string_ref objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (DataObject *fromObj, boost::string_ref objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (boost::string_ref fullPath) override
	Remove a link to another object. More...
StatusCode	updateObject (IRegistry *pDirectory) override
	Update object identified by its directory entry. More...
StatusCode	updateObject (boost::string_ref updatePath) override
	Update object. More...
StatusCode	updateObject (DataObject *toUpdate) override
	Update object. More...
StatusCode	updateObject (boost::string_ref parentPath, boost::string_ref updatePath) override
	Update object. More...
StatusCode	updateObject (DataObject *pParent, boost::string_ref updatePath) override
	Update object. More...
StatusCode	initialize () override
	Service initialization. More...
StatusCode	reinitialize () override
	Service initialization. More...
StatusCode	finalize () override
	Service initialization. More...
	~DataSvc () override
	Standard Destructor. More...
Public Member Functions inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
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...
Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...
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. More...
StatusCode	sysStart () override
	Initialize Service. More...
StatusCode	sysStop () override
	Initialize Service. More...
StatusCode	sysFinalize () override
	Finalize Service. More...
StatusCode	sysReinitialize () override
	Re-initialize the Service. More...
StatusCode	sysRestart () override
	Re-initialize the Service. More...
	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...
template<class T >
StatusCode	service (const std::string &name, const 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 &name, T *&psvc, bool createIf=true) const
template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const
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...
template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...
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. More...
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. More...
Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...
StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...
const Gaudi::Details::PropertyBase &	getProperty (const std::string &name) const override
	get the property by name More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	convert the property to the string More...
const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...
bool	hasProperty (const std::string &name) const override
	Return true if we have a property with the given name. More...
	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) More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

Protected Member Functions
bool	checkRoot ()
	Check if root path is valid. More...
virtual IConversionSvc *	getDataLoader (IRegistry *pReg)
	Retrieve customizable data loader according to registry entry to be retrieved. More...
virtual DataObject *	createDefaultObject () const
	Create default objects in case forced creation of leaves is requested. More...
virtual StatusCode	loadObject (IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation. More...
virtual StatusCode	loadObject (IConversionSvc *pLoader, IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation. More...
StatusCode	retrieveEntry (DataSvcHelpers::RegistryEntry *pNode, boost::string_ref path, DataSvcHelpers::RegistryEntry *&pEntry)
	Retrieve registry entry from store. More...
DataObject *	handleDataFault (IRegistry *pReg, boost::string_ref path="")
	Invoke data fault handling if enabled. More...
Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...
int	outputLevel () const
	get the Service's output level More...
Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const
Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...
MSG::Level	resetMessaging ()
	Reinitialize internal states. More...
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes
SmartIF< IConversionSvc >	m_dataLoader = nullptr
	Pointer to data loader service. More...
SmartIF< IIncidentSvc >	m_incidentSvc = nullptr
	Pointer to incident service. More...
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"}
Gaudi::Property< bool >	m_forceLeaves {this, "ForceLeaves", false, "force creation of default leaves on registerObject"}
Gaudi::Property< std::vector< std::string > >	m_inhibitPathes {this, "InhibitPathes", {}, "inhibited leaves"}
Gaudi::Property< bool >	m_enableFaultHdlr
Gaudi::Property< std::string >	m_faultName {this, "DataFaultName", "DataFault", "Name of the data fault incident"}
Gaudi::Property< bool >	m_enableAccessHdlr
Gaudi::Property< std::string >	m_accessName {this, "DataAccessName", "DataAccess", "Name of the data access incident"}
LoadItems	m_preLoads
	Items to be pre-loaded. More...
DataSvcHelpers::RegistryEntry *	m_root = nullptr
	Pointer to root entry. More...
DataSvcHelpers::InhibitMap *	m_inhibitMap = nullptr
	Map with object paths to be inhibited from loading. More...
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::Property< int >	m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}
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()"}
SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Private Member Functions
	DataSvc (const DataSvc &)=delete
	Fake copy constructor (never implemented). More...
DataSvc &	operator= (const DataSvc &)=delete
	Fake assignment operator (never implemented). More...
StatusCode	i_retrieveEntry (DataSvcHelpers::RegistryEntry *parentObj, boost::string_ref path, DataSvcHelpers::RegistryEntry *&pEntry)
DataObject *	i_handleDataFault (IRegistry *pReg, boost::string_ref path=boost::string_ref{})

Detailed Description

Data service base class.

A data service manages the transient data stores and implements the IDataProviderSvc and IDataManagerSvc interfaces.

Author

Markus Frank

Sebastien Ponce

Version

1.0

Definition at line 44 of file DataSvc.h.

Member Typedef Documentation

typedef std::vector<DataStoreItem> DataSvc::LoadItems

Define set of load items.

Definition at line 48 of file DataSvc.h.

Constructor & Destructor Documentation

DataSvc::~DataSvc ( )

override

Standard Destructor.

Definition at line 1148 of file DataSvc.cpp.

{
  setDataLoader( nullptr ).ignore();
  resetPreLoad().ignore();
  clearStore().ignore();
}

DataSvc::DataSvc ( const DataSvc &  )

privatedelete

Fake copy constructor (never implemented).

Member Function Documentation

StatusCode DataSvc::addPreLoadItem ( const DataStoreItem &  item )

override

Add an item to the preload list.

Definition at line 1019 of file DataSvc.cpp.

{
  auto i = std::find( begin( m_preLoads ), end( m_preLoads ), item );
  if ( i == end( m_preLoads ) ) m_preLoads.push_back( item );
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::addPreLoadItem ( std::string  itemPath )

override

Add an item to the preload list.

Definition at line 1027 of file DataSvc.cpp.

{
  return addPreLoadItem( DataStoreItem( std::move( itemPath ), 1 ) );
}

bool DataSvc::checkRoot ( )

inlineprotected

Check if root path is valid.

Definition at line 321 of file DataSvc.h.

{ return 0 != m_root; }

StatusCode DataSvc::clearStore ( )

override

IDataManagerSvc: Remove all data objects in the data store.

Definition at line 112 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  m_root->release();
  m_root = nullptr;
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::clearSubTree ( boost::string_ref  sub_tree_path )

override

IDataManagerSvc: Remove all data objects below the sub tree identified by its full path name.

Definition at line 84 of file DataSvc.cpp.

{
  DataObject* pObject = nullptr;
  StatusCode  status  = findObject( sub_tree_path, pObject );
  if ( !status.isSuccess() ) return status;
  RegEntry* node_entry = CAST_REGENTRY( RegEntry*, pObject->registry() );
  if ( !node_entry ) return Status::INVALID_OBJECT;
  RegEntry* parent = node_entry->parentEntry();
  if ( !parent ) return Status::INVALID_PARENT;
  parent->remove( node_entry );
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::clearSubTree ( DataObject *  pObject )

override

IDataManagerSvc: Remove all data objects below the sub tree identified by the object.

Definition at line 100 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  RegEntry* entry = CAST_REGENTRY( RegEntry*, pObject->registry() );
  if ( !entry ) return Status::INVALID_OBJECT;
  RegEntry* parent = entry->parentEntry();
  if ( !parent ) return Status::INVALID_PARENT;
  parent->remove( entry );
  return StatusCode::SUCCESS;
}

DataObject * DataSvc::createDefaultObject ( ) const

protectedvirtual

Create default objects in case forced creation of leaves is requested.

Definition at line 1140 of file DataSvc.cpp.

{ return new DataObject(); }

StatusCode DataSvc::finalize ( )

override

Service initialization.

Service initialisation.

Definition at line 1123 of file DataSvc.cpp.

{
  // Nothing to do: just call base class initialisation
  setDataLoader( nullptr ).ignore();
  resetPreLoad().ignore();
  clearStore().ignore();
  m_incidentSvc.reset();
  return Service::finalize();
}

StatusCode DataSvc::findObject ( boost::string_ref  fullPath, DataObject *&  pObject  )

override

Find object identified by its full path in the data store.

Definition at line 795 of file DataSvc.cpp.

{
  pObject = nullptr;
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  if ( path.empty() || path == m_rootName.value() ) {
    pObject = m_root->object();
    return !pObject ? Status::OBJ_NOT_LOADED : Status::IDataProviderSvc_NO_ERROR;
  }
  return ( path.front() != SEPARATOR ) ? findObject( m_rootName.value(), path, pObject )
                                       : findObject( static_cast<IRegistry*>( nullptr ), path, pObject );
}

StatusCode DataSvc::findObject ( IRegistry *  pDirectory, boost::string_ref  path, DataObject *&  pObject  )

override

Find object identified by its full path in the data store.

Retrieve object identified by its directory from the data store.

Definition at line 781 of file DataSvc.cpp.

{
  pObject               = nullptr;
  IRegistry* pReg       = ( pRegistry ? pRegistry : m_root );
  RegEntry*  root_entry = CAST_REGENTRY( RegEntry*, pReg );
  if ( root_entry ) {
    if ( !path.empty() ) pReg = root_entry->find( path );
    if ( !pReg ) return Status::INVALID_OBJ_PATH;
    pObject = pReg->object();
  }
  return ( !pObject ) ? Status::OBJ_NOT_LOADED : Status::IDataProviderSvc_NO_ERROR;
}

StatusCode DataSvc::findObject ( boost::string_ref  parentPath, boost::string_ref  objPath, DataObject *&  pObject  )

override

Find object in the data store.

Retrieve object identified by its full path from the data store.

Definition at line 808 of file DataSvc.cpp.

{
  DataObject* parent = nullptr;
  StatusCode  status = findObject( parentPath, parent );
  return status.isSuccess() ? findObject( parent, objectPath, pObject ) : status;
}

StatusCode DataSvc::findObject ( boost::string_ref  parentPath, int  item, DataObject *&  pObject  )

override

Find object in the data store.

Retrieve object identified by its full path from the data store.

Definition at line 816 of file DataSvc.cpp.

{
  return findObject( parentPath, itemToPath( item ), pObject );
}

StatusCode DataSvc::findObject ( DataObject *  parentObj, boost::string_ref  objPath, DataObject *&  pObject  )

override

Find object in the data store.

Find object identified by its full path in the data store.

Definition at line 828 of file DataSvc.cpp.

{
  IRegistry* pDir = ( parentObj ? parentObj->registry() : nullptr );
  return findObject( pDir, path, pObject );
}

StatusCode DataSvc::findObject ( DataObject *  parentObj, int  item, DataObject *&  pObject  )

override

Find object in the data store.

Find object identified by its full path in the data store.

Definition at line 822 of file DataSvc.cpp.

{
  return findObject( parentObj, itemToPath( item ), pObject );
}

IConversionSvc * DataSvc::getDataLoader ( IRegistry *  pReg )

protectedvirtual

Retrieve customizable data loader according to registry entry to be retrieved.

Reimplemented in NTupleSvc.

Definition at line 1145 of file DataSvc.cpp.

{ return m_dataLoader.get(); }

DataObject * DataSvc::handleDataFault ( IRegistry *  pReg, boost::string_ref  path = ""  )

protected

Invoke data fault handling if enabled.

Parameters

pReg	[IN] Pointer to missing registry entry
path	[IN] Sub-path of requested object from pReg

Returns

Object corresponding to the specified leaf

Definition at line 523 of file DataSvc.cpp.

{
  return i_handleDataFault( pReg, path );
}

DataObject * DataSvc::i_handleDataFault ( IRegistry *  pReg, boost::string_ref  path = boost::string_ref{}  )

private

Definition at line 528 of file DataSvc.cpp.

{
  if ( m_enableFaultHdlr ) {
    IRegistry* pLeaf = nullptr;
    if ( pReg && path.empty() ) {
      DataIncident incident( name(), m_faultName, pReg->identifier() );
      m_incidentSvc->fireIncident( incident );
      return pReg->object();
    }
    if ( pReg ) {
      std::string p = pReg->identifier();
      if ( path.front() != SEPARATOR ) p += SEPARATOR;
      p.append( path.data(), path.size() );
      DataIncident incident( name(), m_faultName, p );
      m_incidentSvc->fireIncident( incident );
      pLeaf = m_root->findLeaf( p );
    } else {
      std::string p = m_root->identifier();
      if ( path.front() != SEPARATOR ) p += SEPARATOR;
      p.append( path.data(), path.size() );
      DataIncident incident( name(), m_faultName, p );
      m_incidentSvc->fireIncident( incident );
      pLeaf = m_root->findLeaf( p );
    }
    if ( pLeaf ) {
      return pLeaf->object();
    }
  }
  return nullptr;
}

StatusCode DataSvc::i_retrieveEntry ( DataSvcHelpers::RegistryEntry *  parentObj, boost::string_ref  path, DataSvcHelpers::RegistryEntry *&  pEntry  )

private

Definition at line 648 of file DataSvc.cpp.

{
  // A.Valassi 16.08.2001 avoid core dump if store is empty
  if ( !checkRoot() ) return StatusCode( Status::INVALID_ROOT, true );

  static const auto empty = boost::string_ref{};
  auto              sep   = find( path, SEPARATOR, 1 );
  pEntry                  = nullptr;

  if ( !parentObj ) {
    if ( path.empty() || path == m_rootName ) {
      parentObj = m_root;
      path      = empty;
    } else if ( path.front() != SEPARATOR ) {
      parentObj = m_root;
    } else if ( sep != boost::string_ref::npos ) {
      if ( !m_root->object() ) {
        RegEntry* r      = nullptr;
        auto      status = i_retrieveEntry( m_root, empty, r );
        if ( !status.isSuccess() ) return status;
      }
      parentObj = m_root;
      path      = path.substr( sep );
    } else {
      return Status::INVALID_OBJ_PATH;
    }
    sep = find( path, SEPARATOR, 1 );
  }

  StatusCode status = StatusCode( Status::INVALID_ROOT, true );
  if ( sep != boost::string_ref::npos ) { // the string contains a separator (after pos 0)
    if ( !parentObj->object() ) {         // if the parent object has not been loaded yet, load it now
      status = loadObject( parentObj );
      if ( !status.isSuccess() ) return status;
    }
    auto      p_path     = path.substr( 0, sep );
    RegEntry* root_entry = parentObj->findLeaf( p_path );
    if ( !root_entry && m_enableFaultHdlr ) {
      // If not even the parent is there, an incident
      // to load the parent must be fired...
      i_handleDataFault( parentObj, p_path );
      root_entry = parentObj->findLeaf( p_path );
    }
    if ( root_entry ) {
      DataObject* pO = root_entry->object();
      if ( !pO ) {
        // Object is not loaded: load the object if at all possible
        status = loadObject( root_entry );
        if ( !status.isSuccess() ) return status;
      }
      if ( root_entry->isSoft() ) {
        root_entry = CAST_REGENTRY( RegEntry*, pO->registry() );
      }
      return i_retrieveEntry( root_entry, path.substr( sep ), pEntry );
    }
    return status;
  } else if ( path.empty() ) {
    pEntry = parentObj;
  } else {
    if ( !parentObj->object() ) { // if the parent object has not been loaded yet, load it now
      status = loadObject( parentObj );
      if ( !status.isSuccess() ) return status;
    }
    // last leave in search: find leaf and load
    pEntry = parentObj->findLeaf( path );
    // If no registry entry was found, trigger incident for action-on-demand
    if ( !pEntry && m_enableFaultHdlr ) {
      i_handleDataFault( parentObj, path );
      pEntry = ( path.empty() ? parentObj : parentObj->findLeaf( path ) );
    }
  }

  // Check results and return
  if ( !pEntry ) return Status::INVALID_OBJ_PATH;
  if ( !pEntry->object() ) return loadObject( pEntry );

  if ( m_enableAccessHdlr ) {
    // Fire data access incident
    // I do not know if this is a good idea....
    // This fires too often!
    //
    // DataIncident incident(name(), m_accessName, pEntry->identifier());
    // m_incidentSvc->fireIncident(incident);
    return StatusCode::SUCCESS;
  }
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::i_setRoot ( std::string  root_path, DataObject *  pRootObj  )

virtual

Initialize data store for new event by giving new event path and root object.

Does not clear the store before reinitializing it. This could lead to errors and should be handle with care. Use setRoot if unsure

Definition at line 161 of file DataSvc.cpp.

{
  if ( pRootObj ) {
    m_root = new RegEntry( std::move( root_path ) );
    m_root->makeHard( pRootObj );
    m_root->setDataSvc( this );
    // No done with GaudiHive. preLoad().ignore();
  }
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::i_setRoot ( std::string  root_path, IOpaqueAddress *  pRootAddr  )

virtual

Initialize data store for new event by giving new event path and address of root object.

Does not clear the store before reinitializing it. This could lead to errors and should be handle with care. Use setRoot if unsure

Definition at line 187 of file DataSvc.cpp.

{
  if ( pRootAddr ) {
    m_root = new RegEntry( std::move( root_path ) );
    m_root->makeHard( pRootAddr );
    m_root->setDataSvc( this );
    // Not done with GaudiHive. preLoad().ignore();
  }
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::initialize ( )

override

Service initialization.

Definition at line 1086 of file DataSvc.cpp.

{
  // Nothing to do: just call base class initialisation
  StatusCode sc = Service::initialize();
  if ( UNLIKELY( !sc.isSuccess() ) ) return sc;
  m_incidentSvc = service( "IncidentSvc", true );
  if ( UNLIKELY( !m_incidentSvc ) ) {
    error() << "Failed to access incident service." << endmsg;
  }
  return sc;
}

StatusCode DataSvc::linkObject ( IRegistry *  from, boost::string_ref  objPath, DataObject *  to  )

override

Add a link to another object.

Definition at line 914 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  try {
    RegEntry* from_entry = CAST_REGENTRY( RegEntry*, from );
    if ( from_entry ) {
      // First check if both objects are already registered to the store
      RegEntry* to_entry = m_root->findLeaf( to );
      if ( !to_entry ) return Status::INVALID_OBJECT;
      auto sep = objPath.rfind( SEPARATOR );
      if ( sep > 0 && sep != boost::string_ref::npos ) { // in case the objPath is a sub-directory itself
        DataObject* pO = nullptr;
        StatusCode  sc = retrieveObject( from, objPath.substr( 0, sep ), pO );
        return sc.isSuccess() ? linkObject( pO->registry(), objPath.substr( sep ), to ) : sc;
      }
      // Now register the soft link
      StatusCode status = from_entry->add( to_string( objPath ), to, true );
      return status.isSuccess() ? Status::IDataProviderSvc_NO_ERROR : Status::DOUBL_OBJ_PATH;
    }
  } catch ( ... ) {
  }
  return Status::INVALID_PARENT;
}

StatusCode DataSvc::linkObject ( boost::string_ref  fromPath, boost::string_ref  objPath, DataObject *  to  )

override

Add a link to another object.

Definition at line 950 of file DataSvc.cpp.

{
  DataObject* pO     = nullptr;
  StatusCode  status = retrieveObject( from, pO );
  return status.isSuccess() ? linkObject( pO->registry(), objPath, to ) : status;
}

StatusCode DataSvc::linkObject ( DataObject *  from, boost::string_ref  objPath, DataObject *  to  )

override

Add a link to another object.

Definition at line 958 of file DataSvc.cpp.

{
  if ( from ) {
    IRegistry* from_entry = from->registry();
    if ( from_entry ) {
      return linkObject( from_entry, objPath, to );
    }
  }
  return Status::INVALID_PARENT;
}

StatusCode DataSvc::linkObject ( boost::string_ref  fullPath, DataObject *  to  )

override

Add a link to another object.

Definition at line 939 of file DataSvc.cpp.

{
  if ( fullPath.empty() ) return Status::INVALID_OBJ_PATH;
  if ( fullPath.front() != SEPARATOR ) {
    return linkObject( m_rootName.value(), fullPath, to );
  }
  auto sep = fullPath.rfind( SEPARATOR );
  return linkObject( fullPath.substr( 0, sep ), fullPath.substr( sep ), to );
}

StatusCode DataSvc::loadObject ( IRegistry *  pNode )

protectedvirtual

Invoke Persistency service to create transient object from its persistent representation.

Definition at line 562 of file DataSvc.cpp.

{
  IConversionSvc* pLoader = getDataLoader( pRegistry );
  return loadObject( pLoader, pRegistry );
}

StatusCode DataSvc::loadObject ( IConversionSvc *  pLoader, IRegistry *  pNode  )

protectedvirtual

Invoke Persistency service to create transient object from its persistent representation.

Definition at line 571 of file DataSvc.cpp.

{
  StatusCode  status  = Status::INVALID_OBJ_ADDR;
  DataObject* pObject = nullptr;
  if ( !pLoader ) { // Precondition: Data loader must be present
    return handleDataFault( pRegistry ) ? StatusCode::SUCCESS : StatusCode( Status::NO_DATA_LOADER );
  }
  if ( !pRegistry ) { // Precondition: Directory must be valid
    return handleDataFault( pRegistry ) ? StatusCode::SUCCESS : StatusCode( Status::INVALID_OBJ_ADDR );
  }

  VERMSG << "Requested object " << pRegistry->identifier() << endmsg;

  if ( m_enableAccessHdlr ) {
    // Fire data access incident
    DataIncident incident( name(), m_accessName, pRegistry->identifier() );
    m_incidentSvc->fireIncident( incident );
  }
  if ( !m_inhibitPathes.empty() ) {
    auto inhibit = std::find( m_inhibitPathes.begin(), m_inhibitPathes.end(), pRegistry->identifier() );
    if ( inhibit != m_inhibitPathes.end() ) {
      return Status::NO_ACCESS;
    }
  }
  IOpaqueAddress* pAddress = pRegistry->address();
  if ( !pAddress ) {                 // Precondition:
    return Status::INVALID_OBJ_ADDR; // Address must be valid
  }
  try {
    status = pLoader->createObj( pAddress, pObject ); // Call data loader
    if ( status.isSuccess() ) {

      VERMSG << "Object " << pRegistry->identifier() << " created" << endmsg;

      RegEntry* pEntry = CAST_REGENTRY( RegEntry*, pRegistry );
      pEntry->setObject( pObject );

      VERMSG << "Filling object " << pRegistry->identifier() << endmsg;
      status = pLoader->fillObjRefs( pAddress, pObject );
    }
  } catch ( const GaudiException& exc ) {
    if ( handleDataFault( pRegistry ) ) {
      return StatusCode::SUCCESS;
    }
    throw GaudiException( "GaudiException in loadObject() " + pRegistry->identifier(), name(), StatusCode::FAILURE,
                          exc );
  } catch ( const std::exception& x ) {
    if ( handleDataFault( pRegistry ) ) {
      return StatusCode::SUCCESS;
    }
    throw GaudiException( "std::exception in loadObject() " + pRegistry->identifier() + ": " +
                              System::typeinfoName( typeid( x ) ) + ", " + x.what(),
                          name(), StatusCode::FAILURE );
  } catch ( ... ) {
    if ( handleDataFault( pRegistry ) ) {
      return StatusCode::SUCCESS;
    }
    throw GaudiException( "UNKN exception in loadObject() " + pRegistry->identifier(), name(), StatusCode::FAILURE );
  }
  if ( !status.isSuccess() ) {
    if ( handleDataFault( pRegistry ) ) {
      return StatusCode::SUCCESS;
    }
  }
  ON_VERBOSE if ( status.isSuccess() )
  {
    verbose() << "Object " << pRegistry->identifier() << " successfully loaded" << endmsg;
  }
  return status;
}

StatusCode DataSvc::objectLeaves ( const DataObject *  pObject, std::vector< IRegistry * > &  refLeaves  )

override

IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object.

IDataManagerSvc: Explore an object identified by its pointer.

Definition at line 223 of file DataSvc.cpp.

{
  if ( !pObject ) return Status::INVALID_OBJECT;
  return objectLeaves( pObject->registry(), leaves );
}

StatusCode DataSvc::objectLeaves ( const IRegistry *  pRegistry, std::vector< IRegistry * > &  refLeaves  )

override

IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object.

IDataManagerSvc: Explore an object identified by the pointer to the registry entry.

Definition at line 232 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  const RegEntry* node_entry = CAST_REGENTRY( const RegEntry*, pRegistry );
  if ( !node_entry ) return Status::INVALID_OBJECT;
  leaves = node_entry->leaves();
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::objectParent ( const DataObject *  pObject, IRegistry *&  refpParent  )

override

IDataManagerSvc: Explore the object store: retrieve the object's parent.

Definition at line 207 of file DataSvc.cpp.

{
  if ( !pObject ) return Status::INVALID_OBJECT;
  return objectParent( pObject->registry(), refpParent );
}

StatusCode DataSvc::objectParent ( const IRegistry *  pRegistry, IRegistry *&  refpParent  )

override

IDataManagerSvc: Explore the object store: retrieve the object's parent.

Definition at line 213 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  const RegEntry* node_entry = CAST_REGENTRY( const RegEntry*, pRegistry );
  if ( !node_entry ) return Status::INVALID_OBJECT;
  refpParent = node_entry->parent();
  return StatusCode::SUCCESS;
}

DataSvc& DataSvc::operator= ( const DataSvc &  )

privatedelete

Fake assignment operator (never implemented).

StatusCode DataSvc::preLoad ( int  depth, int  load_depth, DataObject *  pObject  )

virtual

Execute one level of preloading and recursively load until the final level is reached.

Preload one level deep, then recursively call the next level.

Parameters

depth	current level of loading from requested parent
load_depth	maximum level of object loading
pObject	pointer to next level root object

Returns

Status code indicating success or failure.

Definition at line 1053 of file DataSvc.cpp.

{
  // unused:  StatusCode sc = StatusCode::FAILURE;
  if ( pObject && depth++ < load_depth ) {
    RegEntry* dir = CAST_REGENTRY( RegEntry*, pObject->registry() );
    if ( dir ) {
      for ( const auto& i : *dir ) {
        DataObject* pObj   = nullptr;
        StatusCode  status = retrieveObject( pObject, i->name(), pObj );
        if ( status.isSuccess() && depth < load_depth ) {
          preLoad( depth, load_depth, pObj ).ignore();
        }
      }
    }
  }
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::preLoad ( )

override

load all preload items of the list

Definition at line 1072 of file DataSvc.cpp.

{
  DataObject* pObj = nullptr;
  for ( const auto& i : m_preLoads ) {
    StatusCode sc         = retrieveObject( i.path(), pObj );
    int        load_depth = i.depth();
    if ( sc.isSuccess() && load_depth > 1 ) {
      preLoad( 1, load_depth, pObj ).ignore();
    }
  }
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::registerAddress ( boost::string_ref  fullPath, IOpaqueAddress *  pAddress  )

override

IDataManagerSvc: Register object address with the data store.

Definition at line 242 of file DataSvc.cpp.

{
  if ( fullPath.empty() ) return Status::INVALID_OBJ_PATH;
  return registerAddress( fullPath.front() != SEPARATOR ? m_root : nullptr, fullPath, pAddress );
}

StatusCode DataSvc::registerAddress ( DataObject *  parentObj, boost::string_ref  objectPath, IOpaqueAddress *  pAddress  )

override

IDataManagerSvc: Register object address with the data store.

Definition at line 249 of file DataSvc.cpp.

{
  IRegistry* pRegistry = ( parentObj ? parentObj->registry() : nullptr );
  return registerAddress( pRegistry, objectPath, pAddress );
}

StatusCode DataSvc::registerAddress ( IRegistry *  parentObj, boost::string_ref  objectPath, IOpaqueAddress *  pAddress  )

override

IDataManagerSvc: Register object address with the data store.

Definition at line 256 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  if ( objPath.empty() ) return Status::INVALID_OBJ_PATH;

  if ( !parentObj ) {
    if ( objPath.front() != SEPARATOR ) {
      return registerAddress( m_root, objPath, pAddress );
    }
    auto sep = find( objPath, SEPARATOR, 1 );
    if ( sep == boost::string_ref::npos || objPath.substr( 0, sep ) != m_rootName.value() ) {
      return Status::INVALID_PARENT;
    }
    return registerAddress( m_root, objPath.substr( sep ), pAddress );
  }
  if ( objPath.front() != SEPARATOR ) {
    return registerAddress( parentObj, char( SEPARATOR ) + objPath, pAddress );
  }
  RegEntry* par_entry = CAST_REGENTRY( RegEntry*, parentObj );
  if ( !par_entry ) return Status::INVALID_PARENT;

  auto sep = objPath.rfind( SEPARATOR );
  if ( sep > 0 && sep != boost::string_ref::npos ) {
    auto      p_path  = objPath.substr( 0, sep );
    auto      o_path  = objPath.substr( sep );
    RegEntry* p_entry = par_entry->findLeaf( p_path );
    // Create default object leafs if the
    // intermediate nodes are not present
    if ( !p_entry && m_forceLeaves ) {
      DataObject* pLeaf = createDefaultObject();
      StatusCode  sc    = registerObject( par_entry->identifier(), p_path, pLeaf );
      if ( sc.isFailure() ) delete pLeaf;
      p_entry = par_entry->findLeaf( p_path );
    }
    if ( !p_entry ) return Status::INVALID_PARENT;
    return registerAddress( p_entry, o_path, pAddress );
  }
  StatusCode status = par_entry->add( to_string( objPath ), pAddress );
  return status.isSuccess() ? status : Status::DOUBL_OBJ_PATH;
}

StatusCode DataSvc::registerObject ( boost::string_ref  fullPath, DataObject *  pObject  )

override

Register object with the data store.

Definition at line 343 of file DataSvc.cpp.

{
  return registerObject( nullptr, fullPath, pObject );
}

StatusCode DataSvc::registerObject ( boost::string_ref  parentPath, boost::string_ref  objPath, DataObject *  pObject  )

override

Register object with the data store.

Definition at line 349 of file DataSvc.cpp.

{
  DataObject* pO     = nullptr;
  StatusCode  status = retrieveObject( parentPath, pO );
  if ( !status.isSuccess() && m_forceLeaves ) {
    pO     = createDefaultObject();
    status = registerObject( parentPath, pO );
    if ( !status.isSuccess() ) pO->release();
  }
  return status.isSuccess() ? registerObject( pO, objPath, pObject ) : status;
}

StatusCode DataSvc::registerObject ( boost::string_ref  parentPath, int  item, DataObject *  pObject  )

override

Register object with the data store.

Definition at line 362 of file DataSvc.cpp.

{
  return registerObject( parentPath, itemToPath( item ), pObject );
}

StatusCode DataSvc::registerObject ( DataObject *  parentObj, boost::string_ref  objPath, DataObject *  pObject  )

override

Register object with the data store.

Definition at line 374 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;

  if ( !parentObj ) {
    if ( !objPath.empty() ) {
      if ( objPath.front() != SEPARATOR ) {
        return registerObject( m_rootName.value(), objPath, pObject );
      }
      auto sep = find( objPath, SEPARATOR, 1 );
      if ( sep != boost::string_ref::npos ) {
        return registerObject( objPath.substr( 0, sep ), objPath.substr( sep ), pObject );
      }
    }
    return Status::INVALID_OBJ_PATH;
  }
  RegEntry* node_entry = CAST_REGENTRY( RegEntry*, parentObj->registry() );
  if ( node_entry ) {
    StatusCode status = Status::INVALID_PARENT;
    auto       sep    = find( objPath, SEPARATOR, 1 );
    if ( sep != boost::string_ref::npos ) {
      auto      p_path    = objPath.substr( 0, sep );
      auto      o_path    = objPath.substr( sep );
      RegEntry* par_entry = node_entry->findLeaf( p_path );
      // Create default object leafs if the
      // intermediate nodes are not present
      if ( !par_entry && m_forceLeaves ) {
        DataObject* pLeaf = createDefaultObject();
        StatusCode  sc    = registerObject( parentObj, p_path, pLeaf );
        if ( !sc.isSuccess() ) delete pLeaf;
        par_entry = node_entry->findLeaf( p_path );
      } else if ( par_entry && !par_entry->object() ) {
        status = i_retrieveEntry( node_entry, p_path, par_entry );
        if ( !status.isSuccess() && !par_entry->address() && m_forceLeaves ) {
          DataObject* pLeaf = createDefaultObject();
          StatusCode  sc    = registerObject( parentObj, p_path, pLeaf );
          if ( !sc.isSuccess() ) delete pLeaf;
          par_entry = node_entry->findLeaf( p_path );
        }
      }
      node_entry = par_entry;
      if ( node_entry ) {
        DataObject* obj   = node_entry->object();
        if ( obj ) status = registerObject( obj, o_path, pObject );
      }
    } else {
      RegEntry* leaf = node_entry->findLeaf( objPath );
      if ( !leaf ) {
        status = node_entry->add( to_string( objPath ), pObject );
      } else {
        DataObject* obj = leaf->object();
        if ( !obj ) {
          if ( !pObject ) {
            error() << "registerObject: trying to register null DataObject" << endmsg;
            return StatusCode::FAILURE;
          }
          pObject->setRegistry( leaf );
          leaf->setAddress( nullptr );
          leaf->setObject( pObject );
          status = StatusCode::SUCCESS;
        } else {
          status = Status::DOUBL_OBJ_PATH;
        }
      }
    }
    return status;
  }
  return Status::INVALID_PARENT;
}

StatusCode DataSvc::registerObject ( DataObject *  parentObj, int  item, DataObject *  pObject  )

override

Register object with the data store.

Definition at line 368 of file DataSvc.cpp.

{
  return registerObject( parentObj, itemToPath( item ), pObject );
}

StatusCode DataSvc::reinitialize ( )

override

Service initialization.

Service reinitialization.

Definition at line 1099 of file DataSvc.cpp.

{
  // the finalize part is copied here
  setDataLoader( nullptr ).ignore();
  resetPreLoad().ignore();
  clearStore().ignore();
  m_incidentSvc.reset();
  // re-initialize the base class
  StatusCode sc = Service::reinitialize();
  if ( UNLIKELY( !sc.isSuccess() ) ) {
    error() << "Unable to reinitialize base class" << endmsg;
    return sc;
  }
  // the initialize part is copied here
  m_incidentSvc = service( "IncidentSvc", true );
  if ( UNLIKELY( !m_incidentSvc ) ) {
    error() << "Failed to access incident service." << endmsg;
    return StatusCode::FAILURE;
  }
  // return
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::removePreLoadItem ( const DataStoreItem &  item )

override

Remove an item from the preload list.

Definition at line 1033 of file DataSvc.cpp.

{
  m_preLoads.erase( std::remove( begin( m_preLoads ), end( m_preLoads ), item ), end( m_preLoads ) );
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::removePreLoadItem ( std::string  itemPath )

override

Add an item to the preload list.

Definition at line 1040 of file DataSvc.cpp.

{
  return removePreLoadItem( DataStoreItem( std::move( itemPath ), 1 ) );
}

StatusCode DataSvc::resetPreLoad ( )

override

Clear the preload list.

Definition at line 1046 of file DataSvc.cpp.

{
  m_preLoads.erase( begin( m_preLoads ), end( m_preLoads ) );
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::retrieveEntry ( DataSvcHelpers::RegistryEntry *  pNode, boost::string_ref  path, DataSvcHelpers::RegistryEntry *&  pEntry  )

protected

Retrieve registry entry from store.

Definition at line 643 of file DataSvc.cpp.

{
  return i_retrieveEntry( parentObj, path, pEntry );
}

StatusCode DataSvc::retrieveObject ( IRegistry *  pDirectory, boost::string_ref  path, DataObject *&  pObject  )

override

Retrieve object from data store.

Retrieve object identified by its directory from the data store.

Definition at line 737 of file DataSvc.cpp.

{
  pObject           = nullptr;
  RegEntry * result = nullptr, *parent = CAST_REGENTRY( RegEntry *, pRegistry );
  StatusCode status                 = i_retrieveEntry( parent, path, result );
  if ( status.isSuccess() ) pObject = result->object();
  return status;
}

StatusCode DataSvc::retrieveObject ( boost::string_ref  fullPath, DataObject *&  pObject  )

override

Retrieve object identified by its full path from the data store.

Definition at line 747 of file DataSvc.cpp.

{
  IRegistry* nullDir = nullptr;
  return retrieveObject( nullDir, fullPath, pObject );
}

StatusCode DataSvc::retrieveObject ( boost::string_ref  parentPath, boost::string_ref  objPath, DataObject *&  pObject  )

override

Retrieve object from data store.

Retrieve object identified by its full path from the data store.

Definition at line 754 of file DataSvc.cpp.

{
  DataObject* parent = nullptr;
  StatusCode  status = retrieveObject( parentPath, parent );
  return status.isSuccess() ? retrieveObject( parent, objectPath, pObject ) : status;
}

StatusCode DataSvc::retrieveObject ( boost::string_ref  parentPath, int  item, DataObject *&  pObject  )

override

Retrieve object from data store.

Retrieve object identified by its full path from the data store.

Definition at line 762 of file DataSvc.cpp.

{
  return retrieveObject( parentPath, itemToPath( item ), pObject );
}

StatusCode DataSvc::retrieveObject ( DataObject *  parentObj, boost::string_ref  objPath, DataObject *&  pObject  )

override

Retrieve object from data store.

Definition at line 768 of file DataSvc.cpp.

{
  IRegistry* pRegistry = ( parentObj ? parentObj->registry() : nullptr );
  return retrieveObject( pRegistry, path, pObject );
}

StatusCode DataSvc::retrieveObject ( DataObject *  parentObj, int  item, DataObject *&  pObject  )

override

Retrieve object from data store.

Retrieve registry entry from store.

Definition at line 775 of file DataSvc.cpp.

{
  return retrieveObject( parentObj, itemToPath( item ), pObject );
}

CLID DataSvc::rootCLID ( ) const

override

IDataManagerSvc: Accessor for root event CLID.

CLID for root Event.

Definition at line 1134 of file DataSvc.cpp.

{ return (CLID)m_rootCLID; }

const std::string & DataSvc::rootName ( ) const

override

IDataManagerSvc: Accessor for root event name.

Name for root Event.

Definition at line 1137 of file DataSvc.cpp.

{ return m_rootName; }

StatusCode DataSvc::setDataLoader ( IConversionSvc *  svc, IDataProviderSvc *  dpsvc = nullptr  )

override

IDataManagerSvc: IDataManagerSvc: Pass a default data loader to the service and optionally a data provider.

IDataManagerSvc: Pass a default data loader to the service.

Definition at line 199 of file DataSvc.cpp.

{
  m_dataLoader = pDataLoader;
  if ( m_dataLoader ) m_dataLoader->setDataProvider( dpsvc ? dpsvc : this ).ignore();
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::setRoot ( std::string  root_path, DataObject *  pRootObj  )

override

Initialize data store for new event by giving new event path and root object.

Takes care to clear the store before reinitializing it

Definition at line 150 of file DataSvc.cpp.

{
  clearStore().ignore();
  return i_setRoot( std::move( root_path ), pRootObj );
}

StatusCode DataSvc::setRoot ( std::string  root_path, IOpaqueAddress *  pRootAddr  )

override

Initialize data store for new event by giving new event path and address of root object.

Takes care to clear the store before reinitializing it

Definition at line 176 of file DataSvc.cpp.

{
  clearStore().ignore();
  return i_setRoot( std::move( root_path ), pRootAddr );
}

StatusCode DataSvc::traverseSubTree ( boost::string_ref  sub_tree_path, IDataStoreAgent *  pAgent  )

override

IDataManagerSvc: Analyze by traversing all data objects below the sub tree identified by its full path name.

IDataManagerSvc: Analyse by traversing all data objects below the sub tree identified by its full path name.

Definition at line 123 of file DataSvc.cpp.

{
  DataObject* pO     = nullptr;
  StatusCode  status = findObject( sub_tree_path, pO );
  return status.isSuccess() ? traverseSubTree( pO, pAgent ) : status;
}

StatusCode DataSvc::traverseSubTree ( DataObject *  pObject, IDataStoreAgent *  pAgent  )

override

IDataManagerSvc: Analyze by traversing all data objects below the sub tree.

IDataManagerSvc: Analyse by traversing all data objects below the sub tree.

Definition at line 131 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  RegEntry* entry = CAST_REGENTRY( RegEntry*, pObject->registry() );
  if ( !entry ) return Status::INVALID_OBJECT;
  return entry->traverseTree( pAgent );
}

StatusCode DataSvc::traverseTree ( IDataStoreAgent *  pAgent )

override

IDataManagerSvc: Analyze by traversing all data objects in the data store.

IDataManagerSvc: Analyse by traversing all data objects in the data store.

Definition at line 140 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  return m_root->traverseTree( pAgent );
}

StatusCode DataSvc::unlinkObject ( IRegistry *  from, boost::string_ref  objPath  )

override

Remove a link to another object.

Definition at line 970 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  try {
    RegEntry* from_entry = CAST_REGENTRY( RegEntry*, from );
    if ( from_entry ) {
      auto sep = objPath.rfind( SEPARATOR );
      if ( sep > 0 && sep != boost::string_ref::npos ) { // in case the objPath is a sub-directory itself
        DataObject* pO = nullptr;
        StatusCode  sc = findObject( from, objPath.substr( 0, sep ), pO );
        return sc.isSuccess() ? unlinkObject( pO->registry(), objPath.substr( sep ) ) : sc;
      }
      StatusCode status = from_entry->remove( objPath );
      if ( status.isSuccess() ) return status;
      return Status::INVALID_OBJ_PATH;
    }
  } catch ( ... ) {
  }
  return Status::INVALID_PARENT;
}

StatusCode DataSvc::unlinkObject ( boost::string_ref  fromPath, boost::string_ref  objPath  )

override

Remove a link to another object.

Definition at line 1003 of file DataSvc.cpp.

{
  DataObject* pObject = nullptr;
  StatusCode  status  = findObject( from, pObject );
  return status.isSuccess() ? unlinkObject( pObject->registry(), objPath ) : status;
}

StatusCode DataSvc::unlinkObject ( DataObject *  fromObj, boost::string_ref  objPath  )

override

Remove a link to another object.

Definition at line 1011 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  IRegistry* from_entry = m_root->findLeaf( from );
  return unlinkObject( from_entry, objPath );
}

StatusCode DataSvc::unlinkObject ( boost::string_ref  fullPath )

override

Remove a link to another object.

Definition at line 992 of file DataSvc.cpp.

{
  if ( fullPath.empty() ) return Status::INVALID_OBJ_PATH;
  if ( fullPath.front() != SEPARATOR ) {
    return unlinkObject( m_rootName.value(), fullPath );
  }
  auto sep = fullPath.rfind( SEPARATOR );
  return unlinkObject( fullPath.substr( 0, sep ), fullPath.substr( sep ) );
}

StatusCode DataSvc::unregisterAddress ( boost::string_ref  fullPath )

override

IDataManagerSvc: Unregister object address from the data store.

Definition at line 298 of file DataSvc.cpp.

{
  if ( fullPath.empty() ) return Status::INVALID_OBJ_PATH;
  return unregisterAddress( fullPath.front() != SEPARATOR ? m_root : nullptr, fullPath );
}

StatusCode DataSvc::unregisterAddress ( DataObject *  pParent, boost::string_ref  objPath  )

override

IDataManagerSvc: Unregister object address from the data store.

Definition at line 305 of file DataSvc.cpp.

{
  return unregisterAddress( pParent ? pParent->registry() : nullptr, objPath );
}

StatusCode DataSvc::unregisterAddress ( IRegistry *  pParent, boost::string_ref  objPath  )

override

IDataManagerSvc: Unregister object address from the data store.

Definition at line 311 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  if ( objPath.empty() ) return Status::INVALID_OBJ_PATH;

  if ( !pParent ) {
    if ( objPath.front() != SEPARATOR ) return unregisterAddress( m_root, objPath );
    auto sep = find( objPath, SEPARATOR, 1 );
    if ( sep != boost::string_ref::npos && objPath.substr( 0, sep ) == m_rootName ) {
      return unregisterAddress( m_root, objPath.substr( sep ) );
    }
    return Status::INVALID_PARENT;
  }
  if ( objPath.front() != SEPARATOR ) {
    return unregisterAddress( pParent, char( SEPARATOR ) + objPath );
  }
  RegEntry* node_entry = CAST_REGENTRY( RegEntry*, pParent );
  if ( node_entry ) {
    RegEntry* leaf_entry = node_entry->findLeaf( objPath );
    if ( leaf_entry ) {
      auto sep = objPath.rfind( SEPARATOR );
      if ( sep > 0 && sep != boost::string_ref::npos ) {
        return unregisterAddress( leaf_entry->parent(), objPath.substr( sep ) );
      }
      StatusCode status = node_entry->remove( objPath );
      if ( status.isSuccess() ) return status;
    }
  }
  return Status::INVALID_PARENT;
}

StatusCode DataSvc::unregisterObject ( boost::string_ref  fullPath )

override

Unregister object from the data store.

Definition at line 445 of file DataSvc.cpp.

{
  DataObject* pObject = nullptr;
  StatusCode  status  = findObject( fullPath, pObject );
  if ( status.isFailure() ) return status;
  RegEntry* pEntry = CAST_REGENTRY( RegEntry*, pObject->registry() );
  if ( !pEntry ) return Status::INVALID_ROOT;
  if ( !pEntry->isEmpty() ) return Status::DIR_NOT_EMPTY;
  RegEntry* pParent = pEntry->parentEntry();
  if ( !pParent ) return Status::INVALID_PARENT;
  if ( pObject ) pObject->addRef();
  pParent->remove( pEntry );
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::unregisterObject ( boost::string_ref  parentPath, boost::string_ref  objectPath  )

override

Unregister object from the data store.

Definition at line 461 of file DataSvc.cpp.

{
  DataObject* pO     = nullptr;
  StatusCode  status = findObject( parentPath, pO );
  return status.isSuccess() ? unregisterObject( pO, objPath ) : status;
}

StatusCode DataSvc::unregisterObject ( boost::string_ref  parentPath, int  item  )

override

Unregister object from the data store.

Definition at line 469 of file DataSvc.cpp.

{
  return unregisterObject( parentPath, itemToPath( item ) );
}

StatusCode DataSvc::unregisterObject ( DataObject *  pObject )

override

Unregister object from the data store.

Definition at line 475 of file DataSvc.cpp.

{
  if ( !checkRoot() ) return Status::INVALID_ROOT;
  RegEntry* entry = m_root->findLeaf( pObject );
  if ( !entry ) return Status::INVALID_OBJECT;
  RegEntry* parent = entry->parentEntry();
  if ( !parent ) return Status::INVALID_PARENT;
  if ( !entry->isEmpty() ) return Status::DIR_NOT_EMPTY;
  if ( entry->object() ) entry->object()->addRef();
  if ( parent ) parent->remove( entry );
  return StatusCode::SUCCESS;
}

StatusCode DataSvc::unregisterObject ( DataObject *  pObject, boost::string_ref  objectPath  )

override

Unregister object from the data store.

Definition at line 489 of file DataSvc.cpp.

{
  if ( checkRoot() ) {
    try {
      RegEntry* parent = CAST_REGENTRY( RegEntry*, pParentObj->registry() );
      if ( parent ) {
        RegEntry* entry = parent->findLeaf( objectPath );
        if ( entry ) {
          if ( entry->isEmpty() ) {
            if ( entry->object() ) {
              entry->object()->addRef();
            }
            parent->remove( entry );
            return StatusCode::SUCCESS;
          }
          return Status::DIR_NOT_EMPTY;
        }
        return Status::INVALID_OBJECT;
      }
    } catch ( ... ) {
    }
    return Status::INVALID_PARENT;
  }
  return Status::INVALID_ROOT;
}

StatusCode DataSvc::unregisterObject ( DataObject *  pObject, int  item  )

override

Unregister object from the data store.

Definition at line 516 of file DataSvc.cpp.

{
  return unregisterObject( pParentObj, itemToPath( item ) );
}

StatusCode DataSvc::updateObject ( IRegistry *  pDirectory )

override

Update object identified by its directory entry.

Update object.

Definition at line 843 of file DataSvc.cpp.

{
  if ( !pRegistry ) {                // Precondition:
    return Status::INVALID_OBJ_ADDR; // Addres must be valid
  }
  DataObject* toUpdate = pRegistry->object();
  if ( !toUpdate ) { // Try first to load
    return loadObject( pRegistry );
  }
  return updateObject( toUpdate );
}

StatusCode DataSvc::updateObject ( boost::string_ref  updatePath )

override

Update object.

Definition at line 835 of file DataSvc.cpp.

{
  DataObject* pO     = nullptr;
  StatusCode  status = findObject( updatePath, pO );
  return status.isSuccess() ? updateObject( pO ) : retrieveObject( updatePath, pO );
}

StatusCode DataSvc::updateObject ( DataObject *  toUpdate )

override

Update object.

Definition at line 856 of file DataSvc.cpp.

{
  StatusCode status = Status::INVALID_OBJ_ADDR;
  if ( !toUpdate ) {               // Precondition:
    return Status::INVALID_OBJECT; // Address must be valid
  }
  IRegistry* pRegistry = toUpdate->registry(); // Precondition:
  if ( !pRegistry ) {                          // Need valid registry
    return Status::INVALID_OBJECT;
  }
  IOpaqueAddress* pAddress = pRegistry->address(); // Precondition:
  if ( !pAddress ) {                               // Need valid address
    return Status::INVALID_OBJ_ADDR;
  }
  IConversionSvc* pLoader = getDataLoader( pRegistry );
  if ( !pLoader ) {                // Precondition:
    return Status::NO_DATA_LOADER; // Data loader must be present
  }
  if ( !m_inhibitPathes.empty() ) {
    auto inhibit = std::find( m_inhibitPathes.begin(), m_inhibitPathes.end(), pRegistry->identifier() );
    if ( inhibit != m_inhibitPathes.end() ) {
      return Status::NO_ACCESS;
    }
  }
  try {
    status = pLoader->updateObj( pAddress, toUpdate ); // Call data loader
    if ( status.isSuccess() ) {
      status = pLoader->updateObjRefs( pAddress, toUpdate );
    }
  } catch ( const GaudiException& exc ) {
    throw GaudiException( "GaudiException in updateObject() " + pRegistry->name(), name(), StatusCode::FAILURE, exc );
  } catch ( const std::exception& x ) {
    throw GaudiException( "std::exception in updateObject() " + pRegistry->name() + ": " +
                              System::typeinfoName( typeid( x ) ) + ", " + x.what(),
                          name(), StatusCode::FAILURE );
  } catch ( ... ) {
    throw GaudiException( "UNKN exception in updateObject() " + pRegistry->name(), name(), StatusCode::FAILURE );
  }
  return status;
}

StatusCode DataSvc::updateObject ( boost::string_ref  parentPath, boost::string_ref  updatePath  )

override

Update object.

Definition at line 898 of file DataSvc.cpp.

{
  DataObject* pParent = nullptr;
  StatusCode  status  = findObject( parentPath, pParent );
  return status.isSuccess() ? updateObject( pParent, updatePath ) : status;
}

StatusCode DataSvc::updateObject ( DataObject *  pParent, boost::string_ref  updatePath  )

override

Update object.

Definition at line 906 of file DataSvc.cpp.

{
  DataObject* pObject = nullptr;
  StatusCode  status  = findObject( parent, updatePath, pObject );
  return status.isSuccess() ? updateObject( pObject ) : status;
}

Member Data Documentation

Gaudi::Property<std::string> DataSvc::m_accessName {this, "DataAccessName", "DataAccess", "Name of the data access incident"}

protected

Definition at line 67 of file DataSvc.h.

SmartIF<IConversionSvc> DataSvc::m_dataLoader = nullptr

protected

Pointer to data loader service.

Definition at line 52 of file DataSvc.h.

Gaudi::Property<bool> DataSvc::m_enableAccessHdlr

protected

Initial value:

{this, "EnableAccessHandler", false,
                                           "enable incidents on data access requests"}

Definition at line 65 of file DataSvc.h.

Gaudi::Property<bool> DataSvc::m_enableFaultHdlr

protected

Initial value:

{this, "EnableFaultHandler", false,
                                          "enable incidents on data creation requests"}

Definition at line 61 of file DataSvc.h.

Gaudi::Property<std::string> DataSvc::m_faultName {this, "DataFaultName", "DataFault", "Name of the data fault incident"}

protected

Definition at line 63 of file DataSvc.h.

Gaudi::Property<bool> DataSvc::m_forceLeaves {this, "ForceLeaves", false, "force creation of default leaves on registerObject"}

protected

Definition at line 58 of file DataSvc.h.

SmartIF<IIncidentSvc> DataSvc::m_incidentSvc = nullptr

protected

Pointer to incident service.

Definition at line 54 of file DataSvc.h.

DataSvcHelpers::InhibitMap* DataSvc::m_inhibitMap = nullptr

protected

Map with object paths to be inhibited from loading.

Definition at line 74 of file DataSvc.h.

Gaudi::Property<std::vector<std::string> > DataSvc::m_inhibitPathes {this, "InhibitPathes", {}, "inhibited leaves"}

protected

Definition at line 59 of file DataSvc.h.

LoadItems DataSvc::m_preLoads

protected

Items to be pre-loaded.

Definition at line 70 of file DataSvc.h.

DataSvcHelpers::RegistryEntry* DataSvc::m_root = nullptr

protected

Pointer to root entry.

Definition at line 72 of file DataSvc.h.

Gaudi::Property<CLID> DataSvc::m_rootCLID {this, "RootCLID", 110 , "CLID of root entry"}

protected

Definition at line 56 of file DataSvc.h.

Gaudi::Property<std::string> DataSvc::m_rootName {this, "RootName", "/Event", "name of root entry"}

protected

Definition at line 57 of file DataSvc.h.

---

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

• GaudiKernel/GaudiKernel/DataSvc.h
• GaudiKernel/src/Lib/DataSvc.cpp